Zoom Public API Documentation
List auto receptionists
GET {{baseUrl}}/phone/auto_receptionists?page_size=30&next_page_token=<string>
Use this API to list auto receptionists. Prerequisites:
* Pro or a higher account with Zoom Phone license.
* Account owner or admin permissions. Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_auto_receptionists:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The total number of records returned from a single API call. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"auto_receptionists": [
{
"cost_center": "<string>",
"department": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"timezone": "<string>",
"audio_prompt_language": "<string>",
"holiday_hours": [
{
"id": "<string>",
"name": "<string>",
"from": "<dateTime>",
"to": "<dateTime>"
},
{
"id": "<string>",
"name": "<string>",
"from": "<dateTime>",
"to": "<dateTime>"
}
],
"phone_numbers": [
{
"id": "<string>",
"number": "<string>"
},
{
"id": "<string>",
"number": "<string>"
}
],
"site": {
"id": "<string>",
"name": "<string>"
}
},
{
"cost_center": "<string>",
"department": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"timezone": "<string>",
"audio_prompt_language": "<string>",
"holiday_hours": [
{
"id": "<string>",
"name": "<string>",
"from": "<dateTime>",
"to": "<dateTime>"
},
{
"id": "<string>",
"name": "<string>",
"from": "<dateTime>",
"to": "<dateTime>"
}
],
"phone_numbers": [
{
"id": "<string>",
"number": "<string>"
},
{
"id": "<string>",
"number": "<string>"
}
],
"site": {
"id": "<string>",
"name": "<string>"
}
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/auto_receptionists?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS