Create a call queue

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/phone/call_queues' \
--form 'name=""' \
--form 'site_id=""'

响应示例

201 - response

{
    "extension_number": 10201,
    "id": "SujgNzKq-w",
    "name": "testing123",
    "status": "active"
}

请求参数

Body 参数multipart/form-data

description

string

可选

Description for the Call Queue.

<= 32 字符

extension_number

integer

可选

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

可选

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.

common_area_phone_ids

array[string]

可选

Optional

Unique identifier of the Common Area Phone. This can be retrieved from the List Common Area Phones API.

users

array [object {2}]

可选

Users object. Provide either the id (userId) field or the email address of the user.

name

string

必需

Name of the Call Queue.

>= 1 字符<= 32 字符

site_id

string

必需

Unique identifier of the site. Required only if multiple sites have been enabled. This can be retrieved from the List Phone Sites API.

返回响应

🟢201**HTTP Status Code:** `201` **Created** Call Queue created successfully.

application/json

Body

extension_number

integer

可选

Extension number assigned for the Call Queue.

string

可选

Unique Identifier of the Call Queue.

name

string

可选

Name of the Call Queue.

status

string

可选

Status of the Call Queue.
active: Call queue is enabled and active.
inactive: Call queue is inactive. Inactive call queues cannot be called but will retain its settings and appear in the Call Queues page.

🟠400 **HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` Validation Failed. Multiple Site is disabled. Site does not exist. {extensionNumber} is out of range Exceeded the maximum number to add members per time

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `1001` User not found: {userId}

修改于 2024-04-24 09:06:48

List call queues

Delete a call queue