Evo Voice

<back to all web services

ListMessages

Requires Authentication
The following routes are available for this service:
GET/messages
ListMessages Parameters:
NameParameterData TypeRequiredDescription
AccountIdsqueryList<string>NoThe IDs of the account whose messages you want to retrieve
CustomerIdsqueryList<string>NoThe IDs of the customers whose messages you want to retrieve
EndpointIdsqueryList<string>NoThe IDs of the endpoints whose messages you want to retrieve
ConversationIdsqueryList<string>NoThe ID of the conversations whose messages you want to retrieve
AfterDatequerystringNoThe date after which messages should be retrieved
ListRequest<T> Parameters:
NameParameterData TypeRequiredDescription
PageformintNoThe page of data to retrieve
AllformboolNoIf you want all objects to be returned. This should be used with care
CountPerPageformintNoThe number per page to retrieve
SpecificIdsformList<string>NoSpecific IDs
SortFieldformstringNoSpecify a sort field
SortOrderformSortOrdersNoSpecify a sort order
SimplifiedPagingformboolNoDisables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
SortOrders Enum:
Ascend
Descend
MessageInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
AccountIdformstringNo
CustomerIdformstringNo
EndpointIdformstringNo
EndpointDisplayNameformstringNo
DateformstringNo
DirectionformMessageDirectionsNo
OtherAddressformstringNo
SenderformstringNo
TextformstringNo
IsUnreadformboolNo
MessageDirections Enum:
Incoming
Outgoing
ListResponse<AccountInfo> Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<AccountInfo>NoThe items
TotalCountformintNoThe total number of items
TotalPagesformintNoThe total number of pages
HasMorePagesformboolNoAre there more pages of items? Used with simplified paging
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of this account
ParentAccountIdformstringNoThe ID of this account's parent
TwilioAccountSidformstringNoThe twilio account SID
AncestorIdsformList<string>NoThe ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbersformintNoThe max number of phone numbers this account can have
IsBYOAformboolNoThis account is BYOA
TrustHubProfileSidformstringNoTrustHub Profile Sid
LogoIdformstringNoThe ID of the logo file
LogoUriformstringNoThe URI of the logo file
BillingSettingsformBillingSettingsNoThe billing settings for this account
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
BillingSettings Parameters:
NameParameterData TypeRequiredDescription
BaseformBillingItemNo
LocalNumbersformBillingItemNo
TollFreeNumbersformBillingItemNo
InboundVoiceCallsformBillingItemNo
OutboundVoiceCallsformBillingItemNo
InboundFaxesformBillingItemNo
OutboundFaxesformBillingItemNo
InboundSmsMessagesformBillingItemNo
OutboundSmsMessagesformBillingItemNo
BillingItem Parameters:
NameParameterData TypeRequiredDescription
BaseCostformdoubleNo
RawUnitMultiplierformdoubleNo
UnitCostformdoubleNo
AllowanceformintNo

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 /messages HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			id: String,
			accountId: String,
			customerId: String,
			endpointId: String,
			endpointDisplayName: String,
			date: String,
			direction: Incoming,
			otherAddress: String,
			sender: String,
			text: String,
			isUnread: False
		}
	],
	totalCount: 0,
	totalPages: 0,
	hasMorePages: False
}