Zoom Public API Documentation
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 Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: me value instead of the userId parameter.phone:read,phone:read:admin,phone_voicemail:read:admin,phone_voicemail:readphone:read:list_voicemails,phone:read:list_voicemails:adminMedium
Body
PARAM
| 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": "<date>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": "<integer>",
"to": "<date>",
"total_records": "<integer>",
"voice_mails": [
{
"call_id": "<string>",
"call_log_id": "<string>",
"callee_name": "<string>",
"callee_number": "<string>",
"callee_number_type": 2,
"caller_name": "<string>",
"caller_number": "<string>",
"caller_number_type": 1,
"date_time": "<string>",
"download_url": "<string>",
"duration": "<integer>",
"id": "<string>",
"status": "read"
},
{
"call_id": "<string>",
"call_log_id": "<string>",
"callee_name": "<string>",
"callee_number": "<string>",
"callee_number_type": 2,
"caller_name": "<string>",
"caller_number": "<string>",
"caller_number_type": 2,
"date_time": "<string>",
"download_url": "<string>",
"duration": "<integer>",
"id": "<string>",
"status": "unread"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/voice_mails?page_size=30&status=all&next_page_token=<string>&from=<date>&to=<date>?page_size=30&status=all&next_page_token=<string>&from=<date>&to=<date>' -H 'Accept: application/json'
ENDPOINTS