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:
phone:read:admin
Granular Scopes:
phone:read:list_auto_receptionists:admin
Rate Limit Label
:
Medium
Request Params
| 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":"\u003cstring\u003e","department":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","timezone":"\u003cstring\u003e","audio_prompt_language":"\u003cstring\u003e","holiday_hours":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e"}],"phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"cost_center":"\u003cstring\u003e","department":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","timezone":"\u003cstring\u003e","audio_prompt_language":"\u003cstring\u003e","holiday_hours":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e"}],"phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e"}