POST /phone/call_queues
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to create a call queue.
You can add phone users or common area phones to call queues.
Prerequisites:
- Pro, Business, or Education account
- Account owner or admin permissions
- Zoom Phone license
Scopes:phone:write:admin
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
extension_number |
Integer | No |
Phone extension number for the site. If a site code has been assigned to the site, provide the short extension number instead of the original extension number.. |
members |
Object | No |
A list of one or more phone users to be included in the call queue. Provide either users or common area phone(s). Provide at least one user in the users object. |
members.common_area_phone_ids[] |
Array | No |
Optional |
members.users[] |
Array | No |
Users object. Provide either the id (userId) field or the email address of the user. |
members.users[].id |
String | No |
User Id of the user. This can be retrieved from the List Users API. |
members.users[].email |
String | No |
Email address of the user. This can be retrieved from the List Users API. |
name |
String | Yes |
Name of the Call Queue. |
site_id |
String | Yes |
Unique identifier of the site. Required only if multiple sites have been enabled. This can be retrieved from the List Phone Sites API. |
description |
String | No |
Description for the Call Queue. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.