List an account's inbox messages
GET {{baseUrl}}/contact_center/inboxes/messages?queue_ids=<string>&queue_ids=<string>&inbox_id=<string>&flow_id=<string>&minimum_duration=<integer>&maximum_duration=<integer>&message_type=voicemail&from=<date>&to=<date>&engagement_id=<string>&consumer_number=<string>&status=normal&next_page_token=<string>&page_size=30
Return all messages in an inbox.
Scopes:
contact_center_inbox:read:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| queue_ids | string | | The queue's IDs. The maximum value is 10 |
| queue_ids | string | | The queue's IDs. The maximum value is 10 |
| inbox_id | string | | The inbox's ID. |
| flow_id | string | | The flow's ID. |
| minimum_duration | string | | The minimum duration. |
| maximum_duration | string | | The maximum duration. |
| message_type | string | | The inbox message's type.
- voicemail |
|
from| string | | The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. The date range defined by thefromandtoparameters should be a month maximum, as the response only includes one month's worth of data at once. If unspecified, this parameter returns data from the past 30 days. | |to| string | | Required only when specifying thefromparameter. The end time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, the same format as thefromparameter. | |engagement_id| string | | Filter inbox messages by engagement ID. | |consumer_number| string | | Filter inbox messages by consumer number. | |status| string | | Filter inbox messages by status. | |next_page_token| string | | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |page_size| number | | The number of items returned per page. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","messages":[{"message_id":"\u003cstring\u003e","inbox_id":"\u003cstring\u003e","inbox_name":"\u003cstring\u003e","engagement_id":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e","queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","message_type":"voicemail","download_url":"\u003cstring\u003e","playback_url":"\u003cstring\u003e","transcript_url":"\u003cstring\u003e","message_duration":"\u003cinteger\u003e","consumer_number":"\u003cstring\u003e","consumer_id":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","status":"normal"},{"message_id":"\u003cstring\u003e","inbox_id":"\u003cstring\u003e","inbox_name":"\u003cstring\u003e","engagement_id":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","flow_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e","queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","message_type":"voicemail","download_url":"\u003cstring\u003e","playback_url":"\u003cstring\u003e","transcript_url":"\u003cstring\u003e","message_duration":"\u003cinteger\u003e","consumer_number":"\u003cstring\u003e","consumer_id":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","status":"deleted"}]}