| GET | /conversations |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountIds | query | List<string> | No | The IDs of the account whose conversations you want to retrieve |
| EndpointIds | query | List<string> | No | The list of endpoint IDs whose conversations you want to retrieve |
| CustomerIds | query | List<string> | No | The list of customer IDs whose conversations you want to retrieve |
| AfterDate | query | string | No | The start date for the conversations you want to retrieve |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Conversations | form | List<ConversationInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| EndpointId | form | string | No | |
| OtherAddress | form | string | No | |
| MostRecentMessage | form | MessageInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| AccountId | form | string | No | |
| CustomerId | form | string | No | |
| EndpointId | form | string | No | |
| EndpointDisplayName | form | string | No | |
| Date | form | string | No | |
| Direction | form | MessageDirections | No | |
| OtherAddress | form | string | No | |
| Sender | form | string | No | |
| Text | form | string | No | |
| IsUnread | form | bool | No |
| Incoming | |
| Outgoing |
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 /conversations HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListConversationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Messaging">
<Conversations>
<ConversationInfo>
<EndpointId>String</EndpointId>
<Id>String</Id>
<MostRecentMessage>
<AccountId>String</AccountId>
<CustomerId>String</CustomerId>
<Date>String</Date>
<Direction>Incoming</Direction>
<EndpointDisplayName>String</EndpointDisplayName>
<EndpointId>String</EndpointId>
<Id>String</Id>
<IsUnread>false</IsUnread>
<OtherAddress>String</OtherAddress>
<Sender>String</Sender>
<Text>String</Text>
</MostRecentMessage>
<OtherAddress>String</OtherAddress>
</ConversationInfo>
</Conversations>
</ListConversationsResponse>