Get user's voicemails
GET {{baseUrl}}/phone/users/:userId/voice_mails?page_size=30&status=all&next_page_token=<string>&from=<date>&to=<date>
Use this API to get a user's Zoom Phone voicemails. For user-level apps, pass
the
me
value
instead of the
userId
parameter.
Prerequisites:
- A Business or Enterprise account
- A Zoom Phone license
Scopes:
phone:read
,
phone:read:admin
,
phone_voicemail:read:admin
,
phone_voicemail:read
Granular Scopes:
phone:read:list_voicemails
,
phone:read:list_voicemails:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| page_size | number | | The number of records returned within a single API call. |
| status | string | | Status of the voice mail |
| next_page_token | string | | The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
| 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 as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days. |
| to | string | | Required only when the from parameter is specified. 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. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"from":"\u003cdate\u003e","next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":"\u003cinteger\u003e","to":"\u003cdate\u003e","total_records":"\u003cinteger\u003e","voice_mails":[{"call_id":"\u003cstring\u003e","call_log_id":"\u003cstring\u003e","callee_name":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_number_type":2,"caller_name":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_number_type":1,"date_time":"\u003cstring\u003e","download_url":"\u003cstring\u003e","duration":"\u003cinteger\u003e","id":"\u003cstring\u003e","status":"read"},{"call_id":"\u003cstring\u003e","call_log_id":"\u003cstring\u003e","callee_name":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_number_type":2,"caller_name":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_number_type":2,"date_time":"\u003cstring\u003e","download_url":"\u003cstring\u003e","duration":"\u003cinteger\u003e","id":"\u003cstring\u003e","status":"unread"}]}