Evo Voice

<back to all web services

ListConversations

Requires Authentication
The following routes are available for this service:
GET/conversations
ListConversations Parameters:
NameParameterData TypeRequiredDescription
AccountIdsqueryList<string>NoThe IDs of the account whose conversations you want to retrieve
EndpointIdsqueryList<string>NoThe list of endpoint IDs whose conversations you want to retrieve
CustomerIdsqueryList<string>NoThe list of customer IDs whose conversations you want to retrieve
AfterDatequerystringNoThe start date for the conversations you want to retrieve
ListConversationsResponse Parameters:
NameParameterData TypeRequiredDescription
ConversationsformList<ConversationInfo>No
ConversationInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EndpointIdformstringNo
OtherAddressformstringNo
MostRecentMessageformMessageInfoNo
MessageInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
AccountIdformstringNo
CustomerIdformstringNo
EndpointIdformstringNo
EndpointDisplayNameformstringNo
DateformstringNo
DirectionformMessageDirectionsNo
OtherAddressformstringNo
SenderformstringNo
TextformstringNo
IsUnreadformboolNo
MessageDirections Enum:
Incoming
Outgoing

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

HTTP + JSV

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

GET /conversations HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	conversations: 
	[
		{
			id: String,
			endpointId: String,
			otherAddress: String,
			mostRecentMessage: 
			{
				id: String,
				accountId: String,
				customerId: String,
				endpointId: String,
				endpointDisplayName: String,
				date: String,
				direction: Incoming,
				otherAddress: String,
				sender: String,
				text: String,
				isUnread: False
			}
		}
	]
}