Zoom Public API Documentation
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: Rate Limit Label: contact_center_inbox:read:adminMEDIUM
Body
PARAM
| 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 the `from` and `to` parameters 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 the `from` parameter. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter. | |
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": "<string>",
"page_size": 30,
"total_records": "<integer>",
"messages": [
{
"message_id": "<string>",
"inbox_id": "<string>",
"inbox_name": "<string>",
"engagement_id": "<string>",
"created_at": "<dateTime>",
"flow_id": "<string>",
"flow_name": "<string>",
"queue_id": "<string>",
"queue_name": "<string>",
"message_type": "voicemail",
"download_url": "<string>",
"playback_url": "<string>",
"transcript_url": "<string>",
"message_duration": "<integer>",
"consumer_number": "<string>",
"consumer_id": "<string>",
"consumer_display_name": "<string>",
"status": "normal"
},
{
"message_id": "<string>",
"inbox_id": "<string>",
"inbox_name": "<string>",
"engagement_id": "<string>",
"created_at": "<dateTime>",
"flow_id": "<string>",
"flow_name": "<string>",
"queue_id": "<string>",
"queue_name": "<string>",
"message_type": "voicemail",
"download_url": "<string>",
"playback_url": "<string>",
"transcript_url": "<string>",
"message_duration": "<integer>",
"consumer_number": "<string>",
"consumer_id": "<string>",
"consumer_display_name": "<string>",
"status": "deleted"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/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?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' -H 'Accept: application/json'
ENDPOINTS