| POST | /api/calls |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartDate | body | string | No | The start of the date range to list forms for |
| EndDate | body | string | No | The end of the date range to list forms for |
| ClientId | body | string | No | The ID of the client whose call records you want to list |
| CenterId | body | string | No | The ID of the center whose call records you want to list |
| CallRecordId | body | string | No | The ID of the call record you wish to retrieve |
| MinCallDuration | body | double | No | The minimum duration of the call in seconds (talk time only) |
| MaxCallDuration | body | double | No | The maximum duration of the call in seconds (talk time only) |
| CallType | body | ReceptionCallTypesApi? | No | Filter by call type (do not specify or use null to include both incoming and outgoing) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | int | No | |
| ItemsPerPage | form | int | No | |
| DisableStats | form | bool | No | |
| SortField | form | string | No | |
| SortDir | form | SortDir | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | Yes | The HostedSuite Customer Name |
| UserName | form | string | Yes | The HostedSuite User Name. Data visibility and security is based on this user's permissions. |
| Password | form | string | Yes | The HostedSuite User's Password |
| Asc |
| Desc |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| ClientId | form | string | No | |
| ClientName | form | string | No | |
| CenterId | form | string | No | |
| StartTime | form | string | No | |
| CallerName | form | string | No | |
| CallerNumber | form | string | No | |
| TransferToName | form | string | No | |
| TransferToNumber | form | string | No | |
| Notes | form | string | No | |
| DurationInSeconds | form | double | No | |
| RingTimeInSeconds | form | double | No | |
| HoldTimeInSeconds | form | double | No | |
| HoldCount | form | int | No | |
| Interactions | form | IList<CallRecordInteractionInfo> | No | |
| AnsweredBy | form | string | No | |
| Server | form | string | No | |
| TalkTimeInSeconds | form | double | No | |
| TransferTimeInSeconds | form | double | No | |
| ScreenPop | form | string | No | |
| CompletedFormIds | form | IList<string> | No | |
| Flagged | form | bool | No | |
| FlagNotes | form | string | No | |
| Type | form | string | No | |
| WorkTimeInSeconds | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartTime | form | string | No | |
| Type | form | string | No | |
| Description | form | string | No |
| Incoming |
| Outgoing |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Items | form | List<TItemType> | No | |
| Page | form | int | No | |
| TotalCount | form | long | No | |
| TotalPages | 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.
POST /api/calls HTTP/1.1
Host: cpo.hostedsuite.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ListCallRecordsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
<CustomerName>String</CustomerName>
<Password>String</Password>
<UserName>String</UserName>
<DisableStats>false</DisableStats>
<ItemsPerPage>0</ItemsPerPage>
<Page>0</Page>
<SortDir>Asc</SortDir>
<SortField>String</SortField>
<CallRecordId>String</CallRecordId>
<CallType>Incoming</CallType>
<CenterId>String</CenterId>
<ClientId>String</ClientId>
<EndDate>String</EndDate>
<MaxCallDuration>0</MaxCallDuration>
<MinCallDuration>0</MinCallDuration>
<StartDate>String</StartDate>
</ListCallRecordsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PagedResponseBaseOfCallRecordInfoq5tJnJZa xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
<Items>
<CallRecordInfo>
<AnsweredBy>String</AnsweredBy>
<CallerName>String</CallerName>
<CallerNumber>String</CallerNumber>
<CenterId>String</CenterId>
<ClientId>String</ClientId>
<ClientName>String</ClientName>
<CompletedFormIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<DurationInSeconds>0</DurationInSeconds>
<FlagNotes>String</FlagNotes>
<Flagged>false</Flagged>
<HoldCount>0</HoldCount>
<HoldTimeInSeconds>0</HoldTimeInSeconds>
<Id>String</Id>
<Interactions i:nil="true" />
<Notes>String</Notes>
<RingTimeInSeconds>0</RingTimeInSeconds>
<ScreenPop>String</ScreenPop>
<Server>String</Server>
<StartTime>String</StartTime>
<TalkTimeInSeconds>0</TalkTimeInSeconds>
<TransferTimeInSeconds>0</TransferTimeInSeconds>
<TransferToName>String</TransferToName>
<TransferToNumber>String</TransferToNumber>
<Type>String</Type>
<WorkTimeInSeconds>0</WorkTimeInSeconds>
</CallRecordInfo>
</Items>
<Page>0</Page>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</PagedResponseBaseOfCallRecordInfoq5tJnJZa>