Logo
Zoom Public API Documentation

List an inbox's messages

GET {{baseUrl}}/contact_center/inboxes/:inboxId/messages?queue_ids=<string>&queue_ids=<string>&message_type=voicemail&flow_id=<string>&from=<date>&to=<date>&next_page_token=<string>&page_size=30

Return a list of all messages in an inbox.

Scopes: contact_center_inbox:read:admin

Rate Limit Label: MEDIUM

 

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.
message_type
string The inbox message's type. * voicemail
flow_id
string The flow's ID.
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.
next_page_token
string Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/inboxes/:inboxId/messages?queue_ids=<string>&queue_ids=<string>&message_type=voicemail&flow_id=<string>&from=<date>&to=<date>&next_page_token=<string>&page_size=30?queue_ids=<string>&queue_ids=<string>&message_type=voicemail&flow_id=<string>&from=<date>&to=<date>&next_page_token=<string>&page_size=30' -H 'Accept: application/json'

ENDPOINTS