/restapi/v1.0/account/:accountId/extension/:extensionId/message-store
GET {{baseUrl}}/restapi/v1.0/account/:accountId/extension/:extensionId/message-store?availability=<string>&conversationId=<long>&dateFrom=<dateTime>&dateTo=<dateTime>&direction=<string>&distinctConversations=<boolean>&messageType=<string>&readStatus=<string>&page=<integer>&perPage=<integer>&phoneNumber=<string>
Get Message List
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
availability | string | Specifies the availability status for the resulting messages. Default value is 'Alive'. Multiple values are accepted | |
conversationId | string | Specifies the conversation identifier for the resulting messages | |
dateFrom | string | The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours | |
dateTo | string | The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time | |
direction | string | The direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted | |
distinctConversations | string | If 'True', then the latest messages per every conversation ID are returned | |
messageType | string | The type of the resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted | |
readStatus | string | The read status for the resulting messages. Multiple values are accepted | |
page | string | Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | |
perPage | string | Indicates the page size (number of items). If not specified, the value is '100' by default | |
phoneNumber | string | The phone number. If specified, messages are returned for this particular phone number only |