| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /files |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountIds | query | List<string> | No | Filter by account id |
| CustomerIds | query | List<string> | No | Filter by customer id |
| SessionId | query | string | No | Filter by specific session |
| FileName | query | string | No | Filter by file name (contains filter) |
| ContentType | query | string | No | Filter by content type (contains filter) |
| Type | query | FileTypes? | No | Filter by type |
| DateCreatedStart | query | string | No | Filter by date created (start of range) |
| DateCreatedEnd | query | string | No | Filter by date created (end of range) |
| UserId | query | string | No | Filter by agent ID |
| TranscriptionContains | query | string | No | Search transcription |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | int | No | The page of data to retrieve |
| All | form | bool | No | If you want all objects to be returned. This should be used with care |
| CountPerPage | form | int | No | The number per page to retrieve |
| SpecificIds | form | List<string> | No | Specific IDs |
| SortField | form | string | No | Specify a sort field |
| SortOrder | form | SortOrders | No | Specify a sort order |
| SimplifiedPaging | form | bool | No | Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array |
| Ascend | |
| Descend |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Items | form | List<AccountInfo> | No | The items |
| TotalCount | form | int | No | The total number of items |
| TotalPages | form | int | No | The total number of pages |
| HasMorePages | form | bool | No | Are there more pages of items? Used with simplified paging |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | The name of this account |
| ParentAccountId | form | string | No | The ID of this account's parent |
| TwilioAccountSid | form | string | No | The twilio account SID |
| AncestorIds | form | List<string> | No | The ancestors of this account. Useful for breadcrumbs |
| MaxPhoneNumbers | form | int | No | The max number of phone numbers this account can have |
| IsBYOA | form | bool | No | This account is BYOA |
| TrustHubProfileSid | form | string | No | TrustHub Profile Sid |
| LogoId | form | string | No | The ID of the logo file |
| LogoUri | form | string | No | The URI of the logo file |
| BillingSettings | form | BillingSettings | No | The billing settings for this account |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Base | form | BillingItem | No | |
| LocalNumbers | form | BillingItem | No | |
| TollFreeNumbers | form | BillingItem | No | |
| InboundVoiceCalls | form | BillingItem | No | |
| OutboundVoiceCalls | form | BillingItem | No | |
| InboundFaxes | form | BillingItem | No | |
| OutboundFaxes | form | BillingItem | No | |
| InboundSmsMessages | form | BillingItem | No | |
| OutboundSmsMessages | form | BillingItem | No | |
| AIInsights | form | BillingItem | No | |
| AILiveMinutes | form | BillingItem | No | |
| AIMessages | form | BillingItem | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BaseCost | form | double | No | |
| RawUnitMultiplier | form | double | No | |
| UnitCost | form | double | No | |
| Allowance | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /files HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListResponseOfFileInfoS8MZGchS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
<HasMorePages>false</HasMorePages>
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Files">
<d2p1:FileInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d2p1:AITranscription>String</d2p1:AITranscription>
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AccountName>String</d2p1:AccountName>
<d2p1:ContentLength>0</d2p1:ContentLength>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d4p1:CustomerBreadcrumb>
<d4p1:Id>String</d4p1:Id>
<d4p1:Name>String</d4p1:Name>
</d4p1:CustomerBreadcrumb>
</d2p1:CustomerBreadcrumb>
<d2p1:CustomerId>String</d2p1:CustomerId>
<d2p1:CustomerName>String</d2p1:CustomerName>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FromAddress>String</d2p1:FromAddress>
<d2p1:RecordingDuration>0</d2p1:RecordingDuration>
<d2p1:RecordingFrom>String</d2p1:RecordingFrom>
<d2p1:RecordingSid>String</d2p1:RecordingSid>
<d2p1:ToAddress>String</d2p1:ToAddress>
<d2p1:Transcription>String</d2p1:Transcription>
<d2p1:Type>Upload</d2p1:Type>
<d2p1:Uri>String</d2p1:Uri>
<d2p1:UserId>String</d2p1:UserId>
<d2p1:UserName>String</d2p1:UserName>
</d2p1:FileInfo>
</Items>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</ListResponseOfFileInfoS8MZGchS>