PATCH | /portal/files/{fileId} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | query | string | No | |
FileId | path | string | No | |
FileName | query | string | No | |
CustomerId | query | string | No | |
UserId | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | FileTypes | No | The type of file this is |
AccountId | form | string | No | The account ID this file is associated with |
AccountName | form | string | No | The name of the account this file is associated with |
CustomerId | form | string | No | The ID of the customer this file is associated with |
CustomerName | form | string | No | The name of the customer this file is associated with |
CustomerBreadcrumb | form | List<CustomerBreadcrumb> | No | The breadcrumb to the customer for this file |
UserId | form | string | No | The ID of the user this file is assocaited with |
UserName | form | string | No | The name of the user this file is associated with |
FileName | form | string | No | The original file name for the file |
Uri | form | string | No | The URI of the file |
ContentType | form | string | No | The Content type of the file |
ContentLength | form | long | No | The size of the file |
RecordingSid | form | string | No | The Twilio ID of the recording |
RecordingDuration | form | int | No | The duration of the recording in seconds |
RecordingFrom | form | string | No | Who is the recording from? |
Transcription | form | string | No | Transcription (if available) |
FromAddress | form | string | No | From Address (e.g. caller ID) for incoming calls |
ToAddress | form | string | No | To Address (e.g. dialed number) for outgoing calls |
AITranscription | form | string | No | The AI transcription for this call |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | The ID of the object |
DateCreated | form | string | No | The date the object was created |
DateLastModified | form | string | No | The date the object was last modified |
CreatedBy | form | string | No | The user that created this object |
LastModifiedBy | form | string | No | The user that last modified this object |
Upload | |
VoiceMessage | |
CallRecording | |
Fax | |
Attachment | |
FaxOutgoing |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /portal/files/{fileId} HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
accountId: String,
fileId: String,
fileName: String,
customerId: String,
userId: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { type: Upload, accountId: String, accountName: String, customerId: String, customerName: String, customerBreadcrumb: [ { id: String, name: String } ], userId: String, userName: String, fileName: String, uri: String, contentType: String, contentLength: 0, recordingSid: String, recordingDuration: 0, recordingFrom: String, transcription: String, fromAddress: String, toAddress: String, aiTranscription: String, id: String, dateCreated: String, dateLastModified: String, createdBy: String, lastModifiedBy: String }