Evo Voice

<back to all web services

PatchFile

Updates metadata for the specific file

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
PATCH/files/{fileId}
PatchFile Parameters:
NameParameterData TypeRequiredDescription
FileIdpathstringNoThe ID of the file
FileNamequerystringNoThe new file name for the file
CustomerIdquerystringNoThe customer ID to associate with this file
UserIdquerystringNoThe ID of the user to associate with this file
FileInfo Parameters:
NameParameterData TypeRequiredDescription
TypeformFileTypesNoThe type of file this is
AccountIdformstringNoThe account ID this file is associated with
AccountNameformstringNoThe name of the account this file is associated with
CustomerIdformstringNoThe ID of the customer this file is associated with
CustomerNameformstringNoThe name of the customer this file is associated with
CustomerBreadcrumbformList<CustomerBreadcrumb>NoThe breadcrumb to the customer for this file
UserIdformstringNoThe ID of the user this file is assocaited with
UserNameformstringNoThe name of the user this file is associated with
FileNameformstringNoThe original file name for the file
UriformstringNoThe URI of the file
ContentTypeformstringNoThe Content type of the file
ContentLengthformlongNoThe size of the file
RecordingSidformstringNoThe Twilio ID of the recording
RecordingDurationformintNoThe duration of the recording in seconds
RecordingFromformstringNoWho is the recording from?
TranscriptionformstringNoTranscription (if available)
FromAddressformstringNoFrom Address (e.g. caller ID) for incoming calls
ToAddressformstringNoTo Address (e.g. dialed number) for outgoing calls
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object
FileTypes Enum:
Upload
VoiceMessage
CallRecording
Fax
Attachment
FaxOutgoing
CustomerBreadcrumb Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /files/{fileId} HTTP/1.1 
Host: evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"fileId":"String","fileName":"String","customerId":"String","userId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}