openapi: 3.2.0
info:
title: Phone Call Queues API
description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
contact:
name: Zoom Developers
url: https://developer.zoom.us/
version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Call Queues
paths:
/phone/call_queue_analytics:
get:
tags:
- Call Queues
summary: List call queue analytics
description: 'Returns the call queue analytics overview.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queues:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
operationId: callqueueanalytics
parameters:
- name: page_size
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 300
type: integer
example: 30
default: 30
- name: from
in: query
description: The call start time in GMT **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The earliest data available for query is from 2 years ago. If unspecified, returns data within the 24 hours.
required: true
schema:
type: string
format: date
example: '2025-05-01'
- name: to
in: query
description: The call end time in GMT **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. Queries must be within a one-year interval. If unspecified, it would be present day
required: true
schema:
type: string
format: date
example: '2025-05-15'
- name: next_page_token
in: query
description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: site_id
in: query
description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
required: false
schema:
type: string
example: lA68sMSVQ6GAUcGg_GH0nQ
- name: call_queue_ext_ids
in: query
description: The call queue extension ID list.
required: false
schema:
maxItems: 300
type: array
example: []
items:
type: string
example: 8f71O6rWT8KFUGQmJIFAdQ
- name: department
in: query
description: The department of which the call queue belongs.
required: false
schema:
type: string
example: IT department
- name: cost_center
in: query
description: The cost center where the call queue belongs.
required: false
schema:
type: string
example: HR cost center
responses:
'200':
description: '**HTTP Status Code:** `200` **OK**Call Queues analytics listed successfully.'
content:
application/json:
schema:
type: object
properties:
call_queues:
type: array
description: A list with call queue historical analytics data.
items:
type: object
properties:
call_queue_id:
type: string
description: The unique identifier of the call queue.
example: 3PNsZB50TNev4pgBjtKeDw
call_queue_name:
type: string
description: The name of the call queue.
example: test call queue
call_queue_ext_id:
type: string
description: The extension of the call queue.
example: 8f71O6rWT8KFUGQmJIFAdQ
inbound_calls:
type: integer
description: The number of inbound calls.
example: 500
completed_calls:
type: integer
description: The number of completed calls.
example: 450
abandoned_calls:
type: integer
description: The number of abandoned calls.
example: 40
overflowed_calls:
type: integer
description: The number of overflowed calls.
example: 10
avg_handle_time:
type: integer
description: The average handle time for call in seconds.
example: 180
avg_wrap_up_time:
type: integer
description: The average wrap up time for calls in seconds.
example: 60
avg_in_queue_wait_time:
type: integer
description: The average call wait time in seconds.
example: 30
max_in_queue_wait_time:
type: integer
description: The max call wait time in seconds.
example: 120
outbound_calls:
type: integer
description: The number of outbound calls.
example: 300
outbound_connected_calls:
type: integer
description: The number of connected outbound calls.
example: 450
outbound_unconnected_calls:
type: integer
description: The number of unconnected outbound calls.
example: 30
site_name:
type: string
description: The name of the site for the CQ.
example: SJ Site
site_id:
type: string
description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
example: lA68sMSVQ6GAUcGg_GH0nQ
from:
type: string
description: The start time and date of the log.
example: '2021-10-01'
to:
type: string
description: The end time and date of the log.
example: '2021-10-12'
page_size:
type: integer
description: The number of records returned within a single API call for each page.
example: 30
next_page_token:
type: string
description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:list_call_queues:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_call_queues:admin
/phone/call_queues:
get:
tags:
- Call Queues
summary: List call queues
description: "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.\n Use this API to list Call queues.\n\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queues:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
operationId: listCallQueues
parameters:
- name: next_page_token
in: query
description: 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.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: page_size
in: query
description: The number of records returned from a single API call.
required: false
schema:
maximum: 100
type: integer
example: 30
default: 30
- name: site_id
in: query
description: Unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.
required: false
schema:
type: string
example: 8f71O6rWT8KFUGQmJIFAdQ
- name: cost_center
in: query
description: The call queue's cost center.
required: false
schema:
type: string
example: CQ cost center
- name: department
in: query
description: The call queue's department.
required: false
schema:
type: string
example: Phone department
responses:
'200':
description: '**HTTP Status Code:** `200` **OK**
Call Queues listed successfully.'
content:
application/json:
schema:
type: object
properties:
call_queues:
type: array
items:
type: object
properties:
extension_id:
type: string
description: The extension ID.
example: DgKe5UPTTlODBvcgmRIlPw
extension_number:
type: integer
description: The extension number assigned to the queue.
format: int64
example: 26000026001
id:
type: string
description: Unique identifier of the call queue.
example: 3PNsZB50TNev4pgBjtKeDw
name:
type: string
description: Name of the Call Queue.
example: ApiTA_2020_12_21_19_54_05_476
phone_numbers:
type: array
description: Phone number(s) assigned to the call queue.
items:
type: object
properties:
id:
type: string
description: Unique identifier of the assigned phone number.
example: KsxwNLEhQ0SJ4U4Bor4ShA
number:
type: string
description: The phone number.
example: '+12058945717'
source:
type: string
description: Source
example: internal
enum:
- internal
- external
site:
type: object
properties:
id:
type: string
description: 'Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the Call Queue is assigned. '
example: 8f71O6rWT8KFUGQmJIFAdQ
name:
type: string
description: Name of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
example: Main Site
status:
type: string
description: '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](https://zoom.us/pbx/page/telephone/groups#/groups) page.'
example: active
enum:
- active
- inactive
next_page_token:
type: string
description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: OvrVMfenVmKgsH0SqfWQ2jgUsHFGXeanCB2
page_size:
maximum: 300
type: integer
description: The number of records returned from a single API call.
example: 30
total_records:
type: integer
description: The total number of records found for this query.
example: 1
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:list_call_queues:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_call_queues:admin
post:
tags:
- Call Queues
summary: Create a call queue
description: "[Creates a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413). 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, and so on.\n You can add phone users or common areas to call queues.\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: createCallQueue
requestBody:
content:
application/json:
schema:
required:
- name
- site_id
type: object
properties:
cost_center:
type: string
description: The cost center name.
example: testCostCenter
department:
type: string
description: The department name.
example: testDepartment
description:
maxLength: 32
type: string
description: The description for the call queue.
example: testDescription
extension_number:
type: integer
description: 'The phone extension number for the site.
If a site code has been [assigned](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b) to the site, provide the short extension number instead of the original extension number.'
format: int64
example: 10
members:
type: object
properties:
common_area_ids:
maxItems: 10
type: array
description: "**Optional**\n\n The unique identifier of the [common area](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/listCommonAreas). This can be retrieved from the [List Common Areas](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listCommonAreas) API."
items:
type: string
example: 1pegM6NlSfCEP_jBCfX94A
users:
maxItems: 10
type: array
description: The object of the user. It provides either the 'id' (userId) field or the 'email address' of the user.
items:
type: object
properties:
email:
type: string
description: The email address of the user. It can be retrieved from the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/users) API.
format: email
example: 2021050800001@testapi.com
id:
type: string
description: The user ID. It can be retrieved from the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/users) API.
example: dksc_wq67sach2_3jxs
description: A list of one or more phone users to be included in the call queue. It provides either users or common area(s), or at least one user in the users object.
name:
maxLength: 32
minLength: 1
type: string
description: The name of the call queue.
example: callhandling0001_Not_Delete
site_id:
type: string
description: The unique identifier of the site. It's required only if [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) have been enabled. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.
example: lA68sMSVQ6GAUcGg_GH0nQ
responses:
'201':
description: '**HTTP Status Code:** `201` **Created**
Call queue created successfully.'
content:
application/json:
schema:
type: object
properties:
extension_number:
type: integer
description: The extension number assigned for the call queue.
format: int64
example: 26000026010
id:
type: string
description: The unique identifier of the call queue.
example: IU8_1qAGS1Gf-3e56B_1Lw
name:
type: string
description: The name of the call queue.
example: callhandling0001_Not_Delete
status:
type: string
description: 'The 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](https://zoom.us/pbx/page/telephone/groups#/groups) page.'
example: active
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed.\n\nMultiple Site is disabled.\n\nSite does not exist.\n {extensionNumber} is out of range\n Exceeded the maximum number to add members per time
\n**Error Code:** `400`
\n Invalid short number length.\n Extension number {extensionNumber} is already used.
\n**Error Code:** `412`
\n The maximum number of Call Queue members is up to {maxSize}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `1001`
\n User not found: {userId}
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue:admin
/phone/call_queues/{callQueueId}:
get:
tags:
- Call Queues
summary: Get call queue details
description: "Routes incoming calls to a group of users and returns information on a specific call queue. \n\nFor instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on. \n\n\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getACallQueue
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue. You can retrieve it from the [List Call Queues API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-call-queues/listcallqueues).
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
responses:
'200':
description: '**HTTP Status Code:** `200` **OK**
Call Queue details retrieved successfully. '
content:
application/json:
schema:
type: object
properties:
cost_center:
type: string
description: The name of the cost center.
example: testCostCenter
department:
type: string
description: The name of the department.
example: testDepartment
extension_id:
type: string
description: The extension ID.
example: DgKe5UPTTlODBvcgmRIlPw
extension_number:
type: integer
description: The extension number assigned to the call queue.
format: int64
example: 26000026001
id:
type: string
description: The unique identifier of the call queue.
example: 3PNsZB50TNev4pgBjtKeDw
members:
type: object
properties:
users:
maxItems: 300
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier of the user.
example: yNCY-HBHQ36rkXEXYTwu2g
level:
type: string
description: 'The level of the user. The value can be one of the following:
`manager`: A call queue manager has the privilege to change call queue settings, policy settings and manage recordings and voicemail inbox. There can only be one manager for each call queue.
`user`: Regular user without the privileges of a manager.'
example: user
enum:
- manager
- user
name:
type: string
description: The name of the user.
example: APITA AUTO
receive_call:
type: boolean
description: Whether the user can receive calls or not.
example: true
extension_id:
type: string
description: The extension ID of the user.
example: oeDyBe8zT2SzOZW6gQJXUA
common_areas:
maxItems: 300
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier of the common area.
example: HIlHzOEzS8ymQPFBZ-39AQ
name:
type: string
description: The name of the common area.
example: Common Area
extension_id:
type: string
description: The extension ID of common area.
example: HIlHzOEzS8ymQPFBZ-39AQ
name:
type: string
description: The name of the call queue.
example: ApiTA_2020_12_21_19_54_05_476
phone_numbers:
maxItems: 50
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier of the number.
example: KsxwNLEhQ0SJ4U4Bor4ShA
number:
type: string
description: The phone number.
example: '+12058945717'
source:
type: string
description: The source.
example: internal
enum:
- internal
- external
site:
type: object
properties:
id:
type: string
description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
example: lA68sMSVQ6GAUcGg_GH0nQ
name:
type: string
description: The name of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
example: ApiTA_Site_2020_07_12_00_42_50_109
status:
type: string
description: The status of the call queue.
example: active
enum:
- active
- inactive
policy:
type: object
properties:
voicemail_access_members:
maxItems: 50
uniqueItems: true
type: array
description: The shared voicemail access member list.
items:
allOf:
- type: object
properties:
access_user_id:
type: string
description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or the unique identifier of the common area, depending on the access user type.
example: w0RChiauQeqRlv5fgxYULQ
access_user_type:
type: string
description: 'The extension type of a member in the shared voicemail access member list. Allowed: user | commonArea.'
example: commonArea
enum:
- commonArea
- user
allow_download:
type: boolean
description: Whether the member has download permissions. The default is **false**.
example: false
allow_delete:
type: boolean
description: Whether the member has delete permissions. The default is **false**.
example: false
allow_sharing:
type: boolean
description: Whether the member has the permission to share. The default is **false**.
example: false
- type: object
properties:
shared_id:
type: string
description: The shared voicemail ID.
example: --e8ugg0SeS-9clgrDkn2w
description: The call queue policy list.
timezone:
type: string
description: '[Timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the Call Queue.'
example: Pacific/Midway
audio_prompt_language:
type: string
description: "The language for all default audio prompts for the Call Queue. \n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)"
example: en-US
enum:
- en-US
- en-GB
- es-US
- fr-CA
- da-DK
- de-DE
- es-ES
- fr-FR
- it-IT
- nl-NL
- pt-PT
- ja
- ko-KR
- pt-BR
- zh-CN
default_transcription_language:
type: string
description: "The default language selection for features such as voicemail and call recording.\n* `en-US` — English (US) \n* `en-GB` — English (UK) \n* `es-US` — Spanish (US) \n* `fr-CA` — French (Canada) \n* `da-DK` — Danish (Denmark) \n* `de-DE` — German (Germany) \n* `es-ES` — Spanish (Spain) \n* `fr-FR` — French (France) \n* `it-IT` — Italian (Italy) \n* `nl-NL` — Dutch (Netherlands) \n* `pt-PT` — Portuguese (Portugal) \n* `ja` — Japanese \n* `ko-KR` — Korean (Korea) \n* `pt-BR` — Portuguese (Brazil) \n* `zh-CN` — Chinese (PRC)"
example: en-US
enum:
- en-US
- en-GB
- es-US
- fr-CA
- da-DK
- de-DE
- es-ES
- fr-FR
- it-IT
- nl-NL
- pt-PT
- ja
- ko-KR
- pt-BR
- zh-CN
recording_storage_location:
type: string
description: "Where recording will be stored. Recording includes Phone recordings, voicemail, voicemail transcripts, and custom greeting prompts. \n* `US` : United States \n* `AU` : Australia \n* `CA` : Canada \n* `DE` : Germany \n* `IN` : India \n* `JP` : Japan \n* `SG` : Singapore \n* `BR` : Brazil \n* `CN` : China \n* `MX` : Mexico \n\nNote: \n* If the setting is locked at the Account level, it can't be updated."
example: US
enum:
- US
- AU
- CA
- DE
- IN
- JP
- SG
- BR
- CN
- MX
own_storage_name:
type: string
description: The name of your own storage. Use your own storage provided by Oracle Cloud Infrastructure (OCI) to store Zoom Phone recordings, voicemails, and voicemail transcripts, and custom greeting prompts.
example: us-oracle-storage
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The Call Queue does not exist, callQueueId:{callQueueId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:call_queue:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:call_queue:admin
delete:
tags:
- Call Queues
summary: Delete a call queue
description: "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.\n Use this API to delete a Call Queue.\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
operationId: deleteACallQueue
parameters:
- name: callQueueId
in: path
description: Unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Call Queue deleted successfully. '
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `400`
\nThe group does not exist, groupId:{callQueueId}.\n\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue:admin
patch:
tags:
- Call Queues
summary: Update call queue details
description: "Updates information of a specific call queue. 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, and so on.\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: updateCallQueue
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
requestBody:
content:
application/json:
schema:
type: object
properties:
cost_center:
type: string
description: The cost center name.
example: Cost center
department:
type: string
description: The department name.
example: Department
description:
maxLength: 32
type: string
description: The description for the call queue.
example: Description
extension_number:
type: integer
description: 'The phone extension number for the site.
If a site code has been [assigned](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_79ca9c8f-c97b-4486-aa59-d0d9d31a525b) to the site, provide the short extension number instead of the original extension number.'
format: int64
example: 10
name:
maxLength: 32
type: string
description: The name of the call queue.
example: Call Queue
site_id:
type: string
description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned.
example: 8f71O6rWT8KFUGQmJIFAdQ
status:
type: string
description: 'The status of the call queue. Allowed values:
`active`
`inactive`'
example: active
enum:
- active
- inactive
timezone:
type: string
description: The [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) of the call queue.
example: Pacific/Midway
audio_prompt_language:
type: string
description: "The language for all default audio prompts for the Call Queue. \n* `en-US` : English (US) \n* `en-GB` : English (UK) \n* `es-US` : Spanish (US) \n* `fr-CA` : French (Canada) \n* `da-DK` : Danish (Denmark) \n* `de-DE` : German (Germany) \n* `es-ES` : Spanish (Spain) \n* `fr-FR` : French (France) \n* `it-IT` : Italian (Italy) \n* `nl-NL` : Dutch (Netherlands) \n* `pt-PT` : Portuguese (Portugal) \n* `ja` : Japanese \n* `ko-KR` : Korean (Korea) \n* `pt-BR` : Portuguese (Brazil) \n* `zh-CN` : Chinese (PRC)"
example: en-US
enum:
- en-US
- en-GB
- es-US
- fr-CA
- da-DK
- de-DE
- es-ES
- fr-FR
- it-IT
- nl-NL
- pt-PT
- ja
- ko-KR
- pt-BR
- zh-CN
default_transcription_language:
type: string
description: "The default language selection for features such as voicemail and call recording.\n* `en-US` — English (US) \n* `en-GB` — English (UK) \n* `es-US` — Spanish (US) \n* `fr-CA` — French (Canada) \n* `da-DK` — Danish (Denmark) \n* `de-DE` — German (Germany) \n* `es-ES` — Spanish (Spain) \n* `fr-FR` — French (France) \n* `it-IT` — Italian (Italy) \n* `nl-NL` — Dutch (Netherlands) \n* `pt-PT` — Portuguese (Portugal) \n* `ja` — Japanese \n* `ko-KR` — Korean (Korea) \n* `pt-BR` — Portuguese (Brazil) \n* `zh-CN` — Chinese (PRC)"
example: en-US
enum:
- en-US
- en-GB
- es-US
- fr-CA
- da-DK
- de-DE
- es-ES
- fr-FR
- it-IT
- nl-NL
- pt-PT
- ja
- ko-KR
- pt-BR
- zh-CN
recording_storage_location:
type: string
description: "Where the recording will be stored. Recording includes phone recordings, voicemails, voicemail transcripts, and custom greeting prompts. \n* `US` : United States \n* `AU` : Australia \n* `CA` : Canada \n* `DE` : Germany \n* `IN` : India \n* `JP` : Japan \n* `SG` : Singapore \n* `BR` : Brazil \n* `CN` : China \n* `MX` : Mexico \n\nNote: \n* If the setting is locked at the Account Level, it can't be updated."
example: US
enum:
- US
- AU
- CA
- DE
- IN
- JP
- SG
- BR
- CN
- MX
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Call Queue details updated successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed. The group does not exist, groupId:{groupId}\n\nTimezone not found in the system.
\n**Error Code:** `400`
\n Unable to update this call queue as it is used for internal safety response team.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_queue:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_queue:admin
/phone/call_queues/{callQueueId}/call_handling/settings:
get:
tags:
- Call Queues
summary: Get call queue call handling setting
description: 'Returns the call handling setting of a call queue for the specified hour type.
**Prerequisites**
* A Business or Enterprise account
* A Zoom Phone license
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_call_handling_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: getCallQueueCallHandlingSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: VcuQ6M7JSKO6xOVQ4ZJ2Nw
- name: hour_type
in: query
description: The hour type of the call handling setting.
required: false
schema:
type: string
example: business_hours
enum:
- business_hours
- closed_hours
- holiday_hours
- break_hours
- name: holiday_hour_id
in: query
description: The holiday hour ID. Required when `hour_type` is `holiday_hours`.
required: false
schema:
type: string
example: TNxfEp2WT9emyCsAQt4qnA
- name: break_hour_id
in: query
description: The break hour ID. Required when `hour_type` is `break_hours`.
required: false
schema:
type: string
example: ULfeE4mgSImyelNmTekUfg
responses:
'200':
description: '**HTTP Status Code:** `200` Call queue call handling setting retrieved successfully.'
content:
application/json:
schema:
type: object
properties:
greeting_setting:
type: object
properties:
greeting_prompt:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID.
example: yCT14TwySDGVUypVlKNEyA
audio_name:
type: string
description: The audio prompt file name.
example: greeting-prompt.mp3
description: The audio file played when an incoming call to the call queue is answered.
audio_while_connecting:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID.
example: yCT14TwySDGVUypVlKNEyA
audio_name:
type: string
description: The audio prompt file name.
example: audio-while-connecting.mp3
description: The audio file played while the call is being routed to a queue member.
music_on_hold:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID.
example: yCT14TwySDGVUypVlKNEyA
audio_name:
type: string
description: The audio prompt file name.
example: music-on-hold.mp3
description: The music played to the caller while they are waiting in the queue.
description: The greeting and audio prompt settings of the call queue. Only returned when `hour_type` is `business_hours`.
call_distribution_setting:
type: object
properties:
max_wait_time:
type: integer
description: The maximum time, in seconds, that a caller waits in the queue before the overflow action runs.
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
- 300
- 600
- 900
- 1200
- 1500
- 1800
wrap_up_time:
type: integer
description: The number of seconds a queue member is unavailable to receive a new call after handling a call.
example: 0
enum:
- 0
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
max_call_in_queue:
maximum: 60
minimum: 0
type: integer
description: The maximum number of calls that can be queued at the same time. When the queue is full, the overflow action runs.
example: 60
receive_calls_while_on_a_call:
type: boolean
description: Whether call queue members can receive notifications for new incoming calls while they are already on a call.
example: true
ring_mode:
type: string
description: 'The order in which queue members are rung when a call enters the queue.
* `simultaneous` — All queue members ring at the same time.
* `sequential` — Queue members ring one after another in the configured order.
* `rotating` — Queue members ring in a rotating order, starting from the next member after the last one who took a call.
* `longest_idle` — The queue member with the longest idle time rings first.
* `group_rotating` — Queue members are grouped into rotating groups, and groups ring in a rotating order.
* `custom_group_rotating` — Calls are distributed by rotating through predefined custom groups.'
example: simultaneous
enum:
- simultaneous
- sequential
- rotating
- longest_idle
- group_rotating
- custom_group_rotating
ring_mode_setting:
description: The ring mode-specific sub-settings. Only present when `ring_mode` is not `simultaneous`.
oneOf:
- title: Sequential / Rotating / Longest Idle
type: object
properties:
ring_duration:
type: integer
description: The number of seconds each queue member's device rings before the call is moved to the next member or to the overflow action.
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
handle_multiple_calls:
type: boolean
description: Whether to distribute multiple incoming calls to different queue members instead of all members ringing for the same call.
example: false
skip_offline_device_phone_number:
type: boolean
description: Whether to skip queue members that are offline when distributing the call.
example: false
description: Only returned when `ring_mode` is `sequential`, `rotating`, or `longest_idle`.
- title: Group Rotating
type: object
properties:
ring_duration:
type: integer
description: The number of seconds each rotating group rings before the call is moved to the next group or to the overflow action.
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
group_size:
maximum: 50
minimum: 2
type: integer
description: The number of queue members included in each rotating group.
example: 5
description: Only returned when `ring_mode` is `group_rotating`.
- title: Custom Group Rotating
type: object
properties:
ring_duration:
type: integer
description: The number of seconds a custom rotating group rings before the call moves to the next group or overflow action.
example: 30
custom_groups:
maxItems: 20
type: array
description: The custom groups.
items:
type: object
properties:
custom_group_id:
type: string
description: The unique identifier of the custom group.
example: 4l_dxFbRQR2YpKlcKUpsGw
sequence:
type: integer
description: An integer representing the group's priority order (1-based). Smaller values indicate higher priority.
example: 1
name:
type: string
description: The custom group's display name.
example: Custom Group 1
description:
type: string
description: The custom group description.
example: Custom Group desc
members:
maxItems: 50
type: array
description: The custom group members.
items:
type: object
properties:
extension_id:
type: string
description: The member's extension ID.
example: GQAmmBlqTcGI3dRGv9siug
name:
type: string
description: The extension's display name.
example: User 11021
extension_number:
type: integer
description: The extension number.
example: 11201
description: Only returned when `ring_mode` is `custom_group_rotating`.
allow_members_to_set_own_business_hours:
type: boolean
description: Whether queue members are allowed to set their own business hours.
example: true
description: The call distribution settings that control how incoming calls are routed to queue members. Only returned when `hour_type` is `business_hours`.
call_handling_setting:
type: object
properties:
overflow_action:
type: string
description: 'The action that handles the call when no queue member answers, the wait time exceeds `max_wait_time`, or the queue is full.
* `forward_to_voicemail` — Forward to voicemail.
* `forward_to_extension` — Forward to another internal extension. The target extension type is identified by `forward_to_extension.extension_type`. Supported types: `user`, `callQueue`, `autoReceptionist`, `commonArea`, `sharedLineGroup`, `zoomRoom`, and `ciscoRoom/PolycomRoom`.
* `forward_to_external_contact` — Forward to an external contact.
* `forward_to_external_number` — Forward to an external phone number.
* `forward_to_zoom_contact_center` — Forward to a Zoom Contact Center voice flow.
* `play_message_then_disconnect` — Play a message and then disconnect.
* `disconnect` — Disconnect.
* `forward_to_teams` — Forward to a Microsoft Teams Resource Account. Only returned when the account has Zoom Phone for Microsoft Teams enabled.'
example: forward_to_voicemail
enum:
- forward_to_voicemail
- forward_to_extension
- forward_to_external_contact
- forward_to_external_number
- forward_to_zoom_contact_center
- play_message_then_disconnect
- disconnect
- forward_to_teams
overflow_action_setting:
description: The overflow settings for the overflow action. Only present when `overflow_action` is not `disconnect`.
oneOf:
- title: Forward to Voicemail
type: object
properties:
leave_voicemail_to:
type: object
properties:
extension_id:
type: string
description: 'The voicemail target extension ID. The current call queue''s extension ID indicates the call is routed to the current call queue''s voicemail. A different extension ID indicates that the target extension''s voicemail is used. Supported extension types: user, auto receptionist, call queue, and shared line group.'
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The voicemail target extension number.
format: int64
example: 101014
extension_name:
type: string
description: The voicemail target extension display name.
example: user A
extension_type:
type: string
description: The voicemail target extension type.
example: user
enum:
- user
- autoReceptionist
- callQueue
- sharedLineGroup
description: The voicemail target extension. Determines whose voicemail box receives the message.
connect_to_operator:
type: boolean
description: Whether to allow callers to reach an operator.
example: false
operator_extension:
type: object
properties:
extension_id:
type: string
description: The operator's extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The operator's extension number.
format: int64
example: 101014
extension_name:
type: string
description: The operator's extension display name.
example: user A
extension_type:
type: string
description: The operator's extension type.
example: user
enum:
- user
- callQueue
- autoReceptionist
- commonArea
- sharedLineGroup
- zoomRoom
- ciscoRoom/PolycomRoom
description: The operator's extension information. Only present when `connect_to_operator` is `true`.
voicemail_greeting:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID.
example: yCT14TwySDGVUypVlKNEyA
audio_name:
type: string
description: The audio prompt file name.
example: voicemail-greeting.mp3
description: The voicemail greeting prompt played to the caller before voicemail recording.
leave_voicemail_instruction:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID.
example: yCT14TwySDGVUypVlKNEyA
audio_name:
type: string
description: The audio prompt file name.
example: leave-voicemail-instruction.mp3
description: The leave-voicemail instruction prompt. Only returned when `connect_to_operator` is `true`.
description: Only returned when `overflow_action` is `forward_to_voicemail`.
- title: Forward to Extension
type: object
properties:
forward_to_extension:
type: object
properties:
extension_id:
type: string
description: The extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
extension_number:
type: integer
description: The extension number.
format: int64
example: 101014
extension_name:
type: string
description: The extension display name.
example: user A
extension_type:
type: string
description: The extension type.
example: user
enum:
- user
- callQueue
- autoReceptionist
- commonArea
- sharedLineGroup
- zoomRoom
- ciscoRoom/PolycomRoom
description: The internal extension to forward calls to.
description: Only returned when `overflow_action` is `forward_to_extension`.
- title: Forward to External Contact
type: object
properties:
forward_to_external_contact:
type: object
properties:
external_contact_id:
type: string
description: The external contact's ID.
example: OJGi5xOFQPmrJbKg68-iWg
external_contact_name:
type: string
description: The external contact's name.
example: Johnson
external_contact_email:
type: string
description: The external contact's email address.
example: example@example.com
phone_numbers:
type: array
description: The external contact's phone numbers.
items:
type: string
example: '+12058945656'
description: The external contact to forward calls to.
description: Only returned when `overflow_action` is `forward_to_external_contact`.
- title: Forward to External Number
type: object
properties:
forward_phone_number:
type: string
description: The external phone number to forward calls to, in [E.164 format](https://en.wikipedia.org/wiki/E.164).
example: '+12058945656'
description: Only returned when `overflow_action` is `forward_to_external_number`.
- title: Forward to Zoom Contact Center
type: object
properties:
zoom_contact_center_number:
type: string
description: The Zoom Contact Center entry phone number to forward calls to.
example: '+12058945600'
zoom_contact_center_flow_name:
type: string
description: The Zoom Contact Center flow display name.
example: Sales Inbound Flow
description: Only returned when `overflow_action` is `forward_to_zoom_contact_center`.
- title: Play a Message then Disconnect
type: object
properties:
message_greeting:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID.
example: yCT14TwySDGVUypVlKNEyA
audio_name:
type: string
description: The audio prompt file name.
example: message.mp3
description: The message audio prompt played before disconnecting.
description: Only returned when `overflow_action` is `play_message_then_disconnect`.
- title: Forward to Microsoft Teams Resource Account
type: object
properties:
forward_to_teams:
type: object
properties:
teams_app_id:
type: string
description: The Microsoft Teams Resource Account ID.
example: OJGi5xOFQPmrJbKg68-iWg
teams_voice_app_name:
type: string
description: The Microsoft Teams Resource Account display name.
example: Sales Teams RA
description: The Microsoft Teams Resource Account to forward calls to. Only available when the account has Zoom Phone for Microsoft Teams enabled.
description: Only returned when `overflow_action` is `forward_to_teams`.
description: The overflow and routing action settings of the call queue for the specified hour type. Returned for all hour types.
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15102`
\n Holiday hour does not exist: {holidayHourId}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call Queue does not exist: {callQueueId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:call_queue_call_handling_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:call_queue_call_handling_setting:admin
/phone/call_queues/{callQueueId}/call_handling/settings/{hourType}:
patch:
tags:
- Call Queues
summary: Update call queue call handling setting
description: 'Updates the call handling setting of a call queue for the specified hour type. Only the fields included in the request body are updated; omitted fields are left unchanged. Display-only fields (extension number/name, audio name, external contact name/email, Zoom Contact Center / Microsoft Teams display names) are derived on the server side and must not be sent in the request body.
**Prerequisites:**
* A Business or Enterprise account
* A Zoom Phone license
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_call_handling_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: updateCallQueueCallHandlingSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: VcuQ6M7JSKO6xOVQ4ZJ2Nw
- name: hourType
in: path
description: The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
required: true
schema:
type: string
example: business_hours
enum:
- business_hours
- closed_hours
- holiday_hours
- break_hours
requestBody:
content:
application/json:
schema:
type: object
properties:
holiday_hour_id:
type: string
description: The holiday hour ID. Required when `hourType` is `holiday_hours`.
example: TNxfEp2WT9emyCsAQt4qnA
break_hour_id:
type: string
description: The break hour ID. Required when `hourType` is `break_hours`.
example: ULfeE4mgSImyelNmTekUfg
greeting_setting:
type: object
properties:
greeting_prompt:
type: object
properties:
audio_id:
type: string
description: 'The audio prompt file ID. Send an empty string to clear the greeting prompt and use the system default.
Options:
* Empty string - Default
* `disable` - Disable'
example: yCT14TwySDGVUypVlKNEyA
description: The audio file played when an incoming call to the call queue is answered.
audio_while_connecting:
type: object
properties:
audio_id:
type: string
description: 'The audio prompt file ID.
Options:
* Empty string - Default
* `ring_tone` - Ring tone
* `disable` - Disable'
example: yCT14TwySDGVUypVlKNEyA
description: The audio file played while the call is being routed to a queue member.
music_on_hold:
type: object
properties:
audio_id:
type: string
description: 'The audio prompt file ID. Send an empty string to clear the music on hold.
Options:
* Empty string - Default
* `disable` - Disable'
example: yCT14TwySDGVUypVlKNEyA
description: The music played to the caller while they are waiting in the queue.
description: The greeting and audio prompt settings of the call queue. Only applicable when `hour_type` is `business_hours`.
call_distribution_setting:
type: object
properties:
max_wait_time:
type: integer
description: The maximum time, in seconds, that the caller waits in the queue before the overflow action runs.
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
- 300
- 600
- 900
- 1200
- 1500
- 1800
wrap_up_time:
type: integer
description: The number of seconds a queue member is unavailable to receive a new call after handling a call.
example: 0
enum:
- 0
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 120
- 180
- 240
max_call_in_queue:
maximum: 60
minimum: 0
type: integer
description: The maximum number of calls that can be queued at the same time. When the queue is full, the overflow action runs.
example: 60
receive_calls_while_on_a_call:
type: boolean
description: Whether call queue members can receive notifications for new incoming calls while they are already on a call.
example: true
allow_members_to_set_own_business_hours:
type: boolean
description: Whether queue members are allowed to set their own business hours.
example: true
ring_mode:
type: string
description: 'This field defines the order in which queue members receive incoming calls.
* `simultaneous` — All queue members ring at the same time.
* `sequential` — Queue members ring one after another in the configured order.
* `rotating` — Queue members ring in a rotating order, starting from the next member after the last one who took a call.
* `longest_idle` — The queue member with the longest idle time rings first.
* `group_rotating` — Queue members are grouped into rotating groups, and groups ring in a rotating order.
* `custom_group_rotating` — Calls are distributed by rotating through predefined custom groups. This endpoint is used to switch call distribution to this mode. Detailed custom group management (create/update/delete/reorder groups and members) is handled by the Custom Group OpenAPIs (/phone/call_queues/{callQueueId}/custom_groups and related sub-resources).'
example: simultaneous
enum:
- simultaneous
- sequential
- rotating
- longest_idle
- group_rotating
- custom_group_rotating
ring_mode_setting:
description: The ring mode-specific sub-settings. Only applicable when `ring_mode` is not `simultaneous`.
oneOf:
- title: Sequential / Rotating / Longest Idle
type: object
properties:
ring_duration:
type: integer
description: The number of seconds each queue member's device rings before the call is moved to the next member or to the overflow action.
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
handle_multiple_calls:
type: boolean
description: Whether to distribute multiple incoming calls to different queue members instead of all members ringing for the same call.
example: false
skip_offline_device_phone_number:
type: boolean
description: Whether to skip queue members that are offline when distributing the call.
example: false
description: Only applicable when `ring_mode` is `sequential`, `rotating`, or `longest_idle`.
- title: Group Rotating
type: object
properties:
ring_duration:
type: integer
description: The number of seconds each rotating group rings before the call is moved to the next group or to the overflow action.
example: 30
enum:
- 10
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
group_size:
maximum: 50
minimum: 2
type: integer
description: The number of queue members included in each rotating group.
example: 5
description: Only applicable when `ring_mode` is `group_rotating`.
description: The call distribution settings that control how incoming calls are routed to queue members. Only applicable when `hour_type` is `business_hours`.
call_handling_setting:
type: object
properties:
overflow_action:
type: string
description: 'The action to take when no queue member answers the call, the wait time exceeds `max_wait_time`, or the queue is full.
* `forward_to_voicemail` — Forward to voicemail.
* `forward_to_extension` — Forward to another internal extension.
* `forward_to_external_contact` — Forward to an external contact.
* `forward_to_external_number` — Forward to an external phone number.
* `forward_to_zoom_contact_center` — Forward to a Zoom Contact Center voice flow.
* `play_message_then_disconnect` — Play a message and then disconnect.
* `disconnect` — Disconnect.
* `forward_to_teams` — Forward to a Microsoft Teams Resource Account. Only available when the account has Zoom Phone for Microsoft Teams enabled.'
example: forward_to_voicemail
enum:
- forward_to_voicemail
- forward_to_extension
- forward_to_external_contact
- forward_to_external_number
- forward_to_zoom_contact_center
- play_message_then_disconnect
- disconnect
- forward_to_teams
overflow_action_setting:
description: The overflow settings for the overflow action. Only applicable when `overflow_action` is not `disconnect`.
oneOf:
- title: Forward to Voicemail
type: object
properties:
leave_voicemail_to:
type: object
properties:
extension_id:
type: string
description: 'The voicemail target extension ID. Set to the current call queue''s extension ID to leave the voicemail in the current call queue''s mailbox; set to a different extension ID to leave it in the target extension''s mailbox. Supported extension types: user, auto receptionist, call queue, and shared line group.'
example: jN9mb38lQTaMgxUq3Nd6ow
description: The voicemail target extension.
connect_to_operator:
type: boolean
description: Whether to allow callers to reach an operator.
example: false
operator_extension:
type: object
properties:
extension_id:
type: string
description: The operator extension ID.
example: jN9mb38lQTaMgxUq3Nd6ow
description: The operator extension. Only applicable when `connect_to_operator` is `true`.
voicemail_greeting:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID. Send an empty string to clear the greeting and use the system default.
example: yCT14TwySDGVUypVlKNEyA
description: The voicemail greeting prompt.
leave_voicemail_instruction:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID. Send an empty string to clear the instruction and use the system default.
example: yCT14TwySDGVUypVlKNEyA
description: The leave-voicemail instruction prompt. Only takes effect when `connect_to_operator` is `true`.
description: Only applicable when `overflow_action` is `forward_to_voicemail`.
- title: Forward to Extension
type: object
properties:
forward_to_extension:
required:
- extension_id
type: object
properties:
extension_id:
type: string
description: The internal extension ID to forward calls to.
example: jN9mb38lQTaMgxUq3Nd6ow
description: The internal extension to forward calls to.
description: Only applicable when `overflow_action` is `forward_to_extension`.
- title: Forward to External Contact
type: object
properties:
forward_to_external_contact:
required:
- external_contact_id
type: object
properties:
external_contact_id:
type: string
description: The external contact ID.
example: OJGi5xOFQPmrJbKg68-iWg
description: The external contact to forward calls to.
description: Only applicable when `overflow_action` is `forward_to_external_contact`.
- title: Forward to External Number
required:
- forward_phone_number
type: object
properties:
forward_phone_number:
type: string
description: The external phone number to forward calls to, in [E.164 format](https://en.wikipedia.org/wiki/E.164).
example: '+12058945656'
description: Only applicable when `overflow_action` is `forward_to_external_number`.
- title: Forward to Zoom Contact Center
required:
- zoom_contact_center_number
type: object
properties:
zoom_contact_center_number:
type: string
description: The Zoom Contact Center entry phone number to forward calls to.
example: '+12058945600'
description: Only applicable when `overflow_action` is `forward_to_zoom_contact_center`.
- title: Play a Message then Disconnect
type: object
properties:
message_greeting:
type: object
properties:
audio_id:
type: string
description: The audio prompt file ID. Send an empty string to clear the message and use the system default.
example: yCT14TwySDGVUypVlKNEyA
description: The message audio prompt played before disconnecting.
description: Only applicable when `overflow_action` is `play_message_then_disconnect`.
- title: Forward to Microsoft Teams Resource Account
type: object
properties:
forward_to_teams:
required:
- teams_app_id
type: object
properties:
teams_app_id:
type: string
description: The Microsoft Teams Resource Account ID.
example: OJGi5xOFQPmrJbKg68-iWg
description: The Microsoft Teams Resource Account to forward calls to. Only available when the account has Zoom Phone for Microsoft Teams enabled.
description: Only applicable when `overflow_action` is `forward_to_teams`.
description: The overflow and routing action settings of the call queue for the specified hour type. Applicable to all hour types.
responses:
'204':
description: '**HTTP Status Code:** `204` Call queue call handling setting updated successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15102`
\n Holiday hour does not exist: {holidayHourId}.
\n**Error Code:** `13802`
\n Audio does not exist: {audioId}.
\n**Error Code:** `13808`
\n Extension does not exist: {extension_id}.
\n**Error Code:** `13810`
\n External contact does not exist: {0}.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call Queue does not exist: {callQueueId}.
\n"
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_queue_call_handling_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_queue_call_handling_setting:admin
/phone/call_queues/{callQueueId}/custom_groups:
get:
tags:
- Call Queues
summary: List custom groups of a call queue
description: 'Returns a list of custom groups for a call queue.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_custom_group:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Listcustomgroupsofacallqueue
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
responses:
'200':
description: Custom groups of the call queue returned successfully.
content:
application/json:
schema:
type: object
properties:
custom_groups:
type: array
description: Custom groups.
items:
type: object
properties:
custom_group_id:
type: string
description: The unique identifier of the custom group.
example: 4l_dxFbRQR2YpKlcKUpsGw
sequence:
type: integer
description: An integer representing the group's priority order (1-based). Smaller values indicate higher priority.
example: 1
name:
type: string
description: The custom group display name.
example: Custom Group 1
description:
type: string
description: The custom group description.
example: Custom Group desc
members:
type: array
description: The custom group members.
items:
type: object
properties:
extension_id:
type: string
description: The member's extension ID.
example: GQAmmBlqTcGI3dRGv9siug
name:
type: string
description: The extension display name.
example: User 11021
extension_number:
type: integer
description: The extension number.
example: 11201
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission. \n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The Call Queue does not exist, callQueueId:{callQueueId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:call_queue_custom_group:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:call_queue_custom_group:admin
post:
tags:
- Call Queues
summary: Create a custom group in a call queue
description: '
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_custom_group:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Createacustomgroupinacallqueue
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
requestBody:
content:
application/json:
schema:
required:
- name
type: object
properties:
name:
maxLength: 64
minLength: 1
type: string
description: The custom group display name.
example: Custom Group 1
description:
maxLength: 256
type: string
description: Custom Group description
example: Custom Group desc
member_extension_ids:
maxItems: 50
type: array
description: The member extension IDs. The provided member extension IDs must be part of the call queue members.
items:
type: string
responses:
'201':
description: Custom group details.
content:
application/json:
schema:
type: object
properties:
custom_group_id:
type: string
description: The unique identifier of the custom group.
example: 4l_dxFbRQR2YpKlcKUpsGw
sequence:
type: integer
description: An integer representing the group's priority order (1-based). Smaller values indicate higher priority.
example: 1
name:
type: string
description: The custom group display name.
example: Custom Group 1
description:
type: string
description: Custom Group description.
example: Custom Group desc
members:
maxItems: 50
type: array
description: The custom group members.
items:
type: object
properties:
extension_id:
type: string
description: The member's extension ID.
example: GQAmmBlqTcGI3dRGv9siug
name:
type: string
description: The extension display name.
example: User 11021
extension_number:
type: integer
description: The extension number.
example: 12001
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13003`
\n Custom group limit exceeded.
\n"
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission.\n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The call queue does not exist, callQueueId: {callQueueId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue_custom_group:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue_custom_group:admin
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}:
get:
tags:
- Call Queues
summary: Get call queue custom group detail
description: '
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:master`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_custom_group:admin`,`phone:read:call_queue_custom_group:master`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Getacustomgroup
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: customGroupId
in: path
description: The unique identifier of the custom group.
required: true
schema:
type: string
example: 4l_dxFbRQR2YpKlcKUpsGw
responses:
'200':
description: Custom group details.
content:
application/json:
schema:
type: object
properties:
custom_group_id:
type: string
description: The unique identifier of the custom group.
example: 4l_dxFbRQR2YpKlcKUpsGw
sequence:
type: integer
description: An integer representing the group's priority order (1-based). Smaller values indicate higher priority.
example: 1
name:
type: string
description: The custom group display name.
example: Custom Group 1
description:
type: string
description: Custom Group description.
example: Custom Group desc
members:
maxItems: 50
type: array
description: Custom group members.
items:
type: object
properties:
extension_id:
type: string
description: The member's extension ID.
example: GQAmmBlqTcGI3dRGv9siug
name:
type: string
description: The extension display name.
example: User 11021
extension_number:
type: integer
description: The extension number.
example: 11201
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission.\n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The call queue does not exist, callQueueId: {callQueueId}.
\n**Error Code:** `13002`
\n The custom group does not exist, customGroupId: {customGroupId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:master
- phone:read:call_queue_custom_group:admin
- phone:read:call_queue_custom_group:master
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone:master
x-granular-scopes:
- phone:read:call_queue_custom_group:admin
- phone:read:call_queue_custom_group:master
delete:
tags:
- Call Queues
summary: Delete a custom group
description: 'Delete a custom group.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_custom_group:admin`,`phone:delete:call_queue_custom_group:master`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Deleteacustomgroup
parameters:
- name: callQueueId
in: path
description: The call queue's unique identifier.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: customGroupId
in: path
description: The custom group's unique identifier.
required: true
schema:
type: string
example: 4l_dxFbRQR2YpKlcKUpsGw
responses:
'204':
description: "**HTTP Status Code:** `204` \n \nNo Content "
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission.\n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The call queue does not exist: callQueueId:{callQueueId}.
\n**Error Code:** `13002`
\n The custom group does not exist: customGroupId:{customGroupId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_custom_group:admin
- phone:delete:call_queue_custom_group:master
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_custom_group:admin
- phone:delete:call_queue_custom_group:master
patch:
tags:
- Call Queues
summary: Update a custom group
description: 'Update a custom group.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_custom_group:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Updateacustomgroup
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: customGroupId
in: path
description: The unique identifier of the custom group.
required: true
schema:
type: string
example: 4l_dxFbRQR2YpKlcKUpsGw
requestBody:
description: The request body for updating a custom group.
content:
application/json:
schema:
type: object
properties:
name:
maxLength: 64
minLength: 1
type: string
description: The custom group display name.
example: Custom Group 1
description:
maxLength: 256
type: string
description: Custom Group description
example: Custom Group desc
responses:
'200':
description: Custom group details.
content:
application/json:
schema:
type: object
properties:
custom_group_id:
type: string
description: The unique identifier of the custom group.
example: 4l_dxFbRQR2YpKlcKUpsGw
sequence:
type: string
description: An integer representing the group's priority order (1-based). Smaller values indicate higher priority.
example: '1'
name:
type: string
description: The custom group display name.
example: Custom Group 1
description:
type: string
description: Custom Group description.
example: Custom Group desc
members:
type: array
description: The custom group members.
items:
type: object
properties:
extension_id:
type: string
description: The member's extension ID.
example: GQAmmBlqTcGI3dRGv9siug
name:
type: string
description: The extension display name.
example: User 11021
extension_number:
type: string
description: The extension number.
example: '11012'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed.
\n"
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission. \n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The call queue does not exist, callQueueId: {callQueueId}.
\n**Error Code:** `13002`
\n The custom group does not exist, customGroupId: {customGroupId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_queue_custom_group:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_queue_custom_group:admin
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members:
post:
tags:
- Call Queues
summary: Add members to a custom group
description: 'Adds call queue members to a custom group.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_custom_group_member:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Addmemberstoacustomgroup
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: customGroupId
in: path
description: The unique identifier of the custom group.
required: true
schema:
type: string
example: 4l_dxFbRQR2YpKlcKUpsGw
requestBody:
description: Add call queue members to a custom group.
content:
application/json:
schema:
required:
- member_extension_ids
type: object
properties:
member_extension_ids:
maxItems: 50
minItems: 1
type: array
description: The member extension ID. The provided member extension ID must be part of the call queue members.
items:
type: string
description: The member extension ID. The provided member extension ID must be part of the call queue members.
example: GQAmmBlqTcGI3dRGv9siug
description: The member extension IDs.
responses:
'201':
description: Members added successfully.
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13004`
\n Custom group member limit exceeded.
\n"
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission. \n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The Call Queue does not exist, callQueueId:{callQueueId}.
\n**Error Code:** `13002`
\n The Custom Group does not exist, customGroupId:{customGroupId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue_custom_group_member:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue_custom_group_member:admin
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members/{extensionId}:
delete:
tags:
- Call Queues
summary: Remove a member from a custom group
description: '
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_custom_group_member:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: Removeamemberfromacustomgroup
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: customGroupId
in: path
description: The unique identifier of the custom group.
required: true
schema:
type: string
example: 4l_dxFbRQR2YpKlcKUpsGw
- name: extensionId
in: path
description: The member's extension ID.
required: true
schema:
type: string
example: GQAmmBlqTcGI3dRGv9siug
requestBody:
description: Remove a member from a custom group.
responses:
'204':
description: "**HTTP Status Code:** `204` \n \nNo Content "
'403':
description: "**HTTP Status Code:** `403`
\n Forbidden You do not have permission.\n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The call queue does not exist: {callQueueId}.
\n**Error Code:** `13002`
\n The custom group does not exist: {customGroupId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_custom_group_member:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_custom_group_member:admin
/phone/call_queues/{callQueueId}/members:
get:
tags:
- Call Queues
summary: List call queue members
description: 'Returns a list of call queue members.
**Prerequisites:**
* Pro, Business, or Education account
* Account owner or admin permissions
* Zoom Phone license
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queue_members:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
operationId: listCallQueueMembers
parameters:
- name: callQueueId
in: path
description: The call queue ID that is retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
responses:
'200':
description: '**HTTP Status Code:** `200` **OK**
Call Queue members listed successfully.'
content:
application/json:
schema:
type: object
properties:
call_queue_members:
maxItems: 300
type: array
items:
type: object
properties:
id:
type: string
description: The member ID.
example: yNCY-HBHQ36rkXEXYTwu2g
level:
type: string
description: The level of the member.
example: user
enum:
- commonArea
- user
name:
type: string
description: The name of the user or common area.
example: APITA AUTO
receive_call:
type: boolean
description: Whether the user can receive calls. It displays if the level is user.
example: true
extension_id:
type: string
description: The extension ID of the user or common area.
example: oeDyBe8zT2SzOZW6gQJXUA
next_page_token:
type: string
description: 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.
example: OvrVMfenVmKgsH0SqfWQ2jgUsHFGXeanCB2
page_size:
maximum: 300
type: integer
description: The number of records returned from a single API call.
example: 30
total_records:
type: integer
description: The total number of records found for this query.
example: 1
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n "
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:list_call_queue_members:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_call_queue_members:admin
post:
tags:
- Call Queues
summary: Add members to a call queue
description: 'Adds phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709) as members to a specific call queue.
**Prerequisites:**
* Pro or higher account plan.
* Zoom Phone license
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_member:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: addMembersToCallQueue
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
requestBody:
content:
application/json:
schema:
type: object
properties:
members:
type: object
properties:
common_area_ids:
maxItems: 10
type: array
description: "**Optional**\n\n The unique identifier of the [Common Area](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/listCommonAreas). You can retrieve it from the List Common Areas API."
items:
type: string
example: iewGNg-LSYa0ghhkr4d0Hg
users:
maxItems: 10
type: array
items:
type: object
properties:
email:
type: string
description: The email address of the user.
format: email
example: callhandling0001@testapi.com
id:
type: string
description: The user ID or the unique identifier of the user.
example: wh23uihdqw-43iwdn
description: A maximum of 10 members can be added at a time.
responses:
'201':
description: '**HTTP Status Code:** `201` **Created**
Members added successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed. The group does not exist, groupId:{callQueueId}.\n\nExceeded the maximum number to add members per time.
\n**Error Code:** `412`
\n The maximum number of Call Queue members is up to {maxSize}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `1001`
\n User not found: {userId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue_member:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue_member:admin
delete:
tags:
- Call Queues
summary: Unassign all members
description: 'Removes all members from a call queue who were previously assigned to that call queue. The members could be phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709).
**Prerequisites:**
* Pro or higher account plan.
* Zoom Phone license
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_member:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`'
operationId: unassignAllMembers
parameters:
- name: callQueueId
in: path
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Member unassigned successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nValidation Failed. The group does not exist, groupId:{callQueueId}.\n\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_member:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_member:admin
/phone/call_queues/{callQueueId}/members/{memberId}:
delete:
tags:
- Call Queues
summary: Unassign a member
description: "Removes a member who was previously added to a call queue. The member could be a phone user or common area. Note that you cannot use this API to unassign a call queue manager. \n\n**Prerequisites:**\n\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
operationId: unassignMemberFromCallQueue
parameters:
- name: callQueueId
in: path
description: Unique identifier of the Call Queue from which the member needs to be unassigned.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: memberId
in: path
description: Unique identifier of the member who needs to be unassigned.
required: true
schema:
type: string
example: JpjPXizWTz-l35tFRUK3Gg
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Member unassigned successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nValidation Failed. The group does not exist, groupId:{callQueueId}.\n\n**Error Code:** `400`
\nUnable to delete manager\n\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found\n\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_member:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_member:admin
/phone/call_queues/{callQueueId}/phone_numbers:
post:
tags:
- Call Queues
summary: Assign numbers to a call queue
description: 'Assigns numbers to a call queue. After [buying phone number(s)](https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it and allow callers to directly dial a number to reach a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).
**Prerequisites:**
- Pro or higher account plan
* Account owner or admin permissions
- Zoom Phone license
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_number:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: assignPhoneToCallQueue
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: uvsOCaiDQR2M-NviKFHo0w
requestBody:
content:
application/json:
schema:
type: object
properties:
phone_numbers:
maxItems: 50
type: array
description: This field provides either the `id` or the `number` field. Only a maximum of five numbers can be assigned to a call queue at a time.
items:
type: object
properties:
id:
type: string
description: The unique identifier of the phone number.
example: MbXwdYC0R3GsbUy4iJ7IbQ
number:
type: string
description: The phone number.
example: '+12058945456'
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n Call Queue does not exist: {callQueueId}.
\n**Error Code:** `400`
\n Need to specify at least one phone number
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue_number:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue_number:admin
delete:
tags:
- Call Queues
summary: Unassign all phone numbers
description: "Unbinds all phone numbers that are assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). After successful unbinding, the numbers will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).\n \n If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. \n\n**Prerequisites:**\n* Pro or higher account palan\n* Account owner or admin permissions\n* Zoom Phone license \n\n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: unassignAPhoneNumCallQueue
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: uvsOCaiDQR2M-NviKFHo0w
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Phone numbers unassigned successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed. The group does not exist, groupId:{callQueueId}
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_number:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_number:admin
/phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId}:
delete:
tags:
- Call Queues
summary: Unassign a phone number
description: "Unbinds a phone number from a call queue. After assigning a phone number, you can unbind it if you don't want it to be assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). After successful unbinding, the number will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).\n\n\n**Prerequisites:**\n* Pro or higher account palan\n* Account owner or admin permissions\n* Zoom Phone license \n\n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: unAssignPhoneNumCallQueue
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: uvsOCaiDQR2M-NviKFHo0w
- name: phoneNumberId
in: path
description: 'The phone number ID. '
required: true
schema:
type: string
example: MbXwdYC0R3GsbUy4iJ7IbQ
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Phone Number unassigned successfuly.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed. The group does not exist, groupId:{callQueueId}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Phone number not belong to call queue.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_number:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_number:admin
/phone/call_queues/{callQueueId}/policies:
get:
tags:
- Call Queues
summary: Get call queue policy
description: "Returns the policy setting of a specific [call queue].\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getCallQueuePolicy
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: RkP4R0U8T4C6V0Y2Yw7Q3A
responses:
'200':
description: '**HTTP Status Code:** `200` Call queue policy settings retrieved successfully.'
content:
application/json:
schema:
type: object
properties:
voicemail_transcription:
type: object
properties:
enable:
type: boolean
description: Whether Voicemail Transcription is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
description: When this setting is enabled, voicemail transcriptions will be created and remain accessible even if the setting is later disabled. If the setting is disabled, new voicemail and videomail transcriptions will not be generated.
voicemail_notification_by_email:
type: object
properties:
enable:
type: boolean
description: Whether Voicemail notification by email is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: site
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: false
include_voicemail_file:
type: boolean
description: The include voicemail file.
example: true
include_voicemail_transcription:
type: boolean
description: The include voicemail transcription.
example: true
forward_voicemail_to_email:
type: boolean
description: The specified email addresses will receive a copy of the notification email when there is a new voicemail from the call queue.
example: true
forward_email_list:
type: array
description: The email list.
items:
type: string
description: The recipient email address.
example: vm-alerts@example.com
description: Once enabled, members in the Access Member List will receive email notifications when there is a new voicemail for this call queue.
auto_call_recording:
type: object
properties:
enable:
type: boolean
description: Whether Automatic Call Recording is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
recording_calls:
type: string
description: This field enables you to record calls.
example: inbound_and_outbound
enum:
- inbound_and_outbound
- inbound
- outbound
recording_transcription:
type: boolean
description: Whether to allow transcription.
example: true
allow_stop_resume_recording:
type: boolean
description: Whether users can stop and resume recording.
example: true
disconnect_on_recording_failure:
type: boolean
description: Whether to disconnect the call when recording fails.
example: true
play_recording_beep_tone:
type: object
properties:
enable:
type: boolean
description: Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework.
example: true
play_beep_volume:
type: integer
description: The side tone beep volume. It displays only when `enable` is set to `true`.
example: 60
enum:
- 0
- 20
- 40
- 60
- 80
- 100
play_beep_time_interval:
type: integer
description: The beep time interval in seconds. It displays only when the `enable` is set to true.
example: 15
enum:
- 5
- 10
- 15
- 20
- 25
- 30
- 60
- 120
play_beep_member:
type: string
description: The beep sides. It displays only when the `enable` is set to true.
example: allMember
enum:
- allMember
- recordingSide
description: Plays a recording beep tone.
inbound_audio_notification:
type: object
properties:
recording_start_prompt:
type: boolean
description: Whether to play the inbound recording start prompt.
example: true
recording_start_prompt_audio_id:
type: string
description: The unique identifier of the inbound recording start prompt audio file.
example: Q6wPZB5kT3S6aL9cM1nR2Q
recording_explicit_consent:
type: boolean
description: Whether explicit consent is required for inbound recording.
example: false
description: Inbound audio notification settings.
outbound_audio_notification:
type: object
properties:
recording_start_prompt:
type: boolean
description: Whether to play the outbound recording start prompt.
example: true
recording_start_prompt_audio_id:
type: string
description: The unique identifier of the outbound recording start prompt audio file.
example: H6nM5cV4bX3zA2sD1fG7QW
recording_explicit_consent:
type: boolean
description: Whether explicit consent is required for outbound recording.
example: false
description: Outbound audio notification settings.
description: Automatically record all inbound and outbound calls
ad_hoc_call_recording_for_members:
type: object
properties:
enable:
type: boolean
description: Whether to enabe Ad Hoc Call Recording for Queue Calls.
example: true
description: When enabled, queue member User policy for ad-hoc recording will control whether individual queue members can record. Recordings will be owned by the users. When disabled, queue members cannot record calls for this queue regardless of their User policy.
sms:
type: object
properties:
enable:
type: boolean
description: Whether SMS is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
international_sms:
type: boolean
description: Whether to allow International SMS.
example: false
international_sms_countries:
type: array
description: The country or region.
items:
type: string
description: The supported country or region code.
example: US
description: Call Queue members assigned with Zoom Phone Customer Engagement Pack Plan will receive messages sent to this call queue and also be able to send messages by using this call queue's number as the caller ID.
call_queue_pickup_code:
type: object
properties:
enable:
type: boolean
description: Whether Call Queue Pickup Code is enabled.
example: true
description: After enabling the feature, a unique pickup code will be generated for this queue which can be customized in the Call Queue profile.
online_fax:
type: object
properties:
enable:
type: boolean
description: Whether Online Fax is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: false
fax_notification_by_email:
type: boolean
description: Whether to enable email notifications when a new fax is received.
example: true
fax_notification_email_list:
type: array
description: The email list.
items:
type: string
description: The fax notification email address.
example: vm-alerts@example.com
include_fax_as_attachment:
type: boolean
description: Whether to include fax file as email attachment.
example: true
enable_outbound_fax_transmission_report:
type: boolean
description: Whether to enable transmission report for outbound faxes.
example: true
description: Allows call queue to receive faxes.
sms_template:
type: object
properties:
enable:
type: boolean
description: Whether SMS Templates is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
sms_template_list:
type: array
description: The SMS templates list.
items:
type: object
properties:
sms_template_id:
type: string
description: The unique identifier of the SMS template.
example: a53ff4ee-0af3-4732-b9ea-6d6b782a5f9f
name:
type: string
description: The template name.
example: Follow-up reply
description:
type: string
description: The template description.
example: General follow-up template
content:
type: string
description: The template content.
example: Thanks for contacting us. We will follow up shortly.
active:
type: boolean
description: Whether the template is active at this level.
example: true
description: Uses pre-defined templates to help users compose messages.
sms_auto_reply:
type: object
properties:
enable:
type: boolean
description: Whether SMS Auto Reply is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: false
auto_reply_for_inbound_message:
type: object
properties:
trigger_event_type:
type: string
description: When the auto-reply message is sent. `closed_hours` sends the reply only when the auto receptionist is outside of business hours; `always` sends the reply at all times.
example: closed_hours
enum:
- closed_hours
- always
content:
type: string
description: The text content of the auto-reply message.
example: Thank you for contacting us. We are currently closed and will respond during business hours.
active:
type: boolean
description: The current status of the auto-reply configuration.
example: true
description: SMS auto-reply configurations for inbound message.
description: Enables SMS Auto Reply feature for Call Queue. All the Call Queue members must have a Power Pack license for this feature to work.
call_screening:
type: object
properties:
enable:
type: boolean
description: Whether Call Screening is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
exclude_user_company_contacts:
type: boolean
description: Whether to exclude user and company contacts from call screening, calls will reach users as normal
example: true
description: Incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes.
block_calls_without_caller_id:
type: object
properties:
enable:
type: boolean
description: Whether Block calls without caller ID is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: false
description: Calls without caller ID will be blocked.
call_queue_opt_out_reason:
type: object
properties:
enable:
type: boolean
description: Whether Call Queue Opt-out Reason is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
call_queue_opt_out_reasons_list:
type: array
description: The opt-out reasons list.
items:
type: object
properties:
code:
type: string
description: The opt-out reason text.
example: Lunch break
system:
type: boolean
description: Whether this is a built-in system reason.
example: false
enable:
type: boolean
description: Whether the opt-out reason is enabled.
example: true
description: Sets the opt-out reasons for Call Queues. When enabled, Call Queue members will need to select an opt-out reason when they turn off receive queue call feature.
auto_answer_call_queue_calls:
type: object
properties:
enable:
type: boolean
description: Whether Auto-answer call queue calls is enabled.
example: false
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: site
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: false
description: Allows call queue members to auto-answer incoming calls on a desktop client. Current call routing and distribution won't be affected.
auto_delete_data_after_retention_duration:
type: object
properties:
enable:
type: boolean
description: Whether auto deletion of data after retention duration is enabled.
example: false
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults. If true, the settings can be reset.
example: false
items:
type: array
description: This field enables you to delete items.
items:
type: object
properties:
type:
type: string
description: The data types.
example: callLog
enum:
- callLog
- automaticRecording
- voicemail
- sms
- fax
duration:
type: integer
description: The retention duration where -1 means unlimited. For units of time, see the `time_unit` below. For `year`, the duration:-1, 1-10; for `day`, the duration:-1, 1-60; for `month`, the duration:-1, 1-18.
example: -1
time_unit:
type: string
description: The unit of time.
example: day
enum:
- day
delete_type:
type: integer
description: "The deletion policy. \n * 1 - soft delete \n * 2 - permanent delete"
example: 1
enum:
- 1
- 2
permanently_delete_after_days:
type: integer
description: The number of days after which the data will be permanently deleted automatically. Use -1 to retain data indefinitely.
example: -1
description: Allows Zoom to automatically delete data after retention duration. Requires the Advanced Retention account feature to be enabled.
team_sms_thread_summary:
type: object
properties:
enable:
type: boolean
description: Whether Team SMS thread summary with AI Companion is enabled.
example: true
locked:
type: boolean
description: Whether the senior administrator allows users to modify the current settings.
example: false
locked_by:
type: string
description: Which level has locked this setting.
example: invalid
enum:
- invalid
- account
- site
modified:
type: boolean
description: Whether the current settings have been changed from inherited defaults.
example: true
description: Allows users to summarize and extract tasks from English SMS conversations. The time period is 24 hours from the last message. Team SMS only applies to SMS conversations from Auto Receptionist and Call Queue phone numbers and requires a Power Pack license.
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call Queue does not exist: {callQueueId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:call_queue_policy:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:call_queue_policy:admin
patch:
tags:
- Call Queues
summary: Update call queue policy
description: "Updates a call queue's policy settings.\n\n**Prerequisites**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: updateCallQueuePolicy
parameters:
- name: callQueueId
in: path
description: The unique identifier of the call queue.
required: true
schema:
type: string
example: RkP4R0U8T4C6V0Y2Yw7Q3A
requestBody:
content:
application/json:
schema:
type: object
properties:
voicemail_transcription:
type: object
properties:
enable:
type: boolean
description: Whether Voicemail Transcription is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
description: When this setting is enabled, voicemail transcriptions will be created and remain accessible even if the setting is later disabled. If the setting is disabled, new voicemail and videomail transcriptions will not be generated.
voicemail_notification_by_email:
type: object
properties:
enable:
type: boolean
description: Whether Voicemail notification by email is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
include_voicemail_file:
type: boolean
description: Whether to include the voicemail file.
example: true
include_voicemail_transcription:
type: boolean
description: Whether to include the voicemail transcription.
example: true
forward_voicemail_to_email:
type: boolean
description: Whether to specify the email addresses that will receive a copy of the notification email when there is a new voicemail from the call queue.
example: true
forward_email_list:
maxItems: 3
type: array
description: The email list.
items:
type: string
description: The recipient email address.
example: vm-alerts@example.com
description: Once enabled, members in the Access Member List will receive email notifications when there is a new voicemail for this call queue.
auto_call_recording:
type: object
properties:
enable:
type: boolean
description: Whether Automatic Call Recording is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
recording_calls:
type: string
description: This field enables you to record calls.
example: inbound_and_outbound
enum:
- inbound_and_outbound
- inbound
- outbound
recording_transcription:
type: boolean
description: Whether to allow transcriptions.
example: false
recording_explicit_consent:
type: boolean
description: Whether explicit consent is required before recording.
example: false
allow_stop_resume_recording:
type: boolean
description: Whether users can stop and resume recording.
example: true
disconnect_on_recording_failure:
type: boolean
description: Whether to disconnect the call when recording fails.
example: false
play_recording_beep_tone:
type: object
properties:
enable:
type: boolean
description: Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework.
example: true
play_beep_volume:
type: integer
description: The side tone beep volume. It displays only when `enable` is set to `true`.
example: 60
enum:
- 0
- 20
- 40
- 60
- 80
- 100
play_beep_time_interval:
type: integer
description: The beep time interval in seconds. It displays only when the `enable` is set to true.
example: 15
enum:
- 5
- 10
- 15
- 20
- 25
- 30
- 60
- 120
play_beep_member:
type: string
description: The beep sides. It displays only when the `enable` is set to true.
example: allMember
enum:
- allMember
- recordingSide
description: Plays a recording beep tone.
inbound_audio_notification:
type: object
properties:
recording_start_prompt:
type: boolean
description: Whether to play the inbound recording start prompt.
example: true
recording_start_prompt_audio_id:
type: string
description: The unique identifier of the inbound recording start prompt audio file.
example: Q6wPZB5kT3S6aL9cM1nR2Q
recording_explicit_consent:
type: boolean
description: Whether explicit consent is required for inbound recording.
example: false
description: Inbound audio notification settings.
outbound_audio_notification:
type: object
properties:
recording_start_prompt:
type: boolean
description: Whether to play the outbound recording start prompt.
example: true
recording_start_prompt_audio_id:
type: string
description: The unique identifier of the outbound recording start prompt audio file.
example: H6nM5cV4bX3zA2sD1fG7QW
recording_explicit_consent:
type: boolean
description: Whether explicit consent is required for outbound recording.
example: false
description: Outbound audio notification settings.
description: Automatically records all inbound and outbound calls.
ad_hoc_call_recording_for_members:
type: object
properties:
enable:
type: boolean
description: Whether to allow member Ad Hoc Call Recording for Queue Calls to be enabled.
example: true
description: When enabled, queue member User policy for ad-hoc recording will control whether individual queue members can record. Recordings will be owned by the users. When disabled, queue members cannot record calls for this queue regardless of their User policy.
sms:
type: object
properties:
enable:
type: boolean
description: Whether SMS is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
international_sms:
type: boolean
description: Whether to allow International SMS.
example: false
international_sms_countries:
type: array
description: The country or region.
items:
type: string
description: The supported country or region code.
example: US
description: Call Queue members assigned with Zoom Phone Power Pack Plan will receive messages sent to this call queue and also be able to send messages by using this call queue's number as the caller ID.
call_queue_pickup_code:
type: object
properties:
enable:
type: boolean
description: Whether the Call Queue Pickup Code is enabled.
example: true
description: After enabling the feature, a unique pickup code will be generated for this queue which can be customized in the Call Queue profile.
online_fax:
type: object
properties:
enable:
type: boolean
description: Whether Online Fax is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
fax_notification_by_email:
type: boolean
description: Whether to enable email notifications when a new fax is received.
example: true
fax_notification_email_list:
type: array
description: The email list.
items:
type: string
description: The fax notification email address.
example: vm-alerts@example.com
include_fax_as_attachment:
type: boolean
description: Whether to include fax file as email attachment.
example: true
enable_outbound_fax_transmission_report:
type: boolean
description: Whether to enable transmission report for outbound faxes.
example: true
description: Allows call queue to receive faxes.
sms_template:
type: object
properties:
enable:
type: boolean
description: Whether SMS Templates is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
sms_template_list:
type: array
description: The SMS templates list.
items:
type: object
properties:
sms_template_id:
type: string
description: The unique identifier of the SMS template.
example: a53ff4ee-0af3-4732-b9ea-6d6b782a5f9f
active:
type: boolean
description: Whether the template is active at this level.
example: true
description: Uses pre-defined templates to help users compose messages.
sms_auto_reply:
type: object
properties:
enable:
type: boolean
description: Whether SMS Auto Reply is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
auto_reply_for_inbound_message:
type: object
properties:
trigger_event_type:
type: string
description: When the auto-reply message is sent. `closed_hours` sends the reply only when the auto receptionist is outside of business hours; `always` sends the reply at all times.
example: closed_hours
enum:
- closed_hours
- always
content:
type: string
description: The text content of the auto-reply message.
example: Thank you for contacting us. We are currently closed and will respond during business hours.
active:
type: boolean
description: The current status of the auto-reply configuration.
example: true
description: SMS auto-reply configurations for inbound message.
description: Enables SMS Auto Reply feature for Call Queue. All the Call Queue members must have a Power Pack license for this feature to work.
call_screening:
type: object
properties:
enable:
type: boolean
description: Whether Call Screening is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
exclude_user_company_contacts:
type: boolean
description: Excludes the user and company contacts from call screening. Calls will reach users as normal.
example: true
description: Incoming direct external callers will be prompted to respond to a button to reach users. Callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes.
block_calls_without_caller_id:
type: object
properties:
enable:
type: boolean
description: Whether Block calls without caller ID is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
description: Calls without caller ID will be blocked.
call_queue_opt_out_reason:
type: object
properties:
enable:
type: boolean
description: Whether Call Queue Opt-out Reason is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
call_queue_opt_out_reasons_list:
type: array
description: The opt-out reasons list
items:
type: object
properties:
code:
type: string
description: The opt-out reason text.
example: Lunch break
enable:
type: boolean
description: Whether the opt-out reason is enabled.
example: true
description: Sets the opt-out reasons for Call Queues. When enabled, Call Queue members will need to select an opt-out reason when they turn off receive queue call feature.
auto_answer_call_queue_calls:
type: object
properties:
enable:
type: boolean
description: Whether Auto-answer call queue calls is enabled.
example: false
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
description: Allows call queue members to auto-answer incoming calls on a desktop client. Current call routing and distribution won't be affected.
auto_delete_data_after_retention_duration:
type: object
properties:
enable:
type: boolean
description: Whether auto deletion of data after retention duration is enabled.
example: false
reset:
type: boolean
description: Whether to reset this setting to inherited defaults from the parent level.
example: false
items:
type: array
description: The retention policy configurations for different data types.
items:
type: object
properties:
type:
type: string
description: The type of data subject to the retention policy.
example: voicemail
enum:
- callLog
- automaticRecording
- voicemail
- sms
- fax
time_unit:
type: string
description: The time unit for the retention duration.
example: day
enum:
- day
duration:
type: integer
description: The retention duration in the specified time unit. Use -1 for unlimited retention.
example: 180
delete_type:
type: integer
description: "The deletion policy. \n * 1 - soft delete \n * 2 - permanent delete"
example: 1
enum:
- 1
- 2
permanently_delete_after_days:
type: integer
description: The number of days after which the data will be permanently deleted automatically. Use -1 to retain data indefinitely.
example: -1
description: Allows Zoom to automatically delete data after retention duration. Requires the Advanced Retention account feature to be enabled.
team_sms_thread_summary:
type: object
properties:
enable:
type: boolean
description: Whether Team SMS thread summary with AI Companion is enabled.
example: true
reset:
type: boolean
description: Whether to reset the setting to the inherited value.
example: false
description: Allows users to summarize and extract tasks from English SMS conversations. The time period is 24 hours from the last message. Team SMS only applies to SMS conversations from Auto Receptionist and Call Queue phone numbers and requires a Power Pack license.
responses:
'204':
description: '**HTTP Status Code:** `204` Call queue policy settings updated successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13802`
\n Audio does not exist: {audioId}.
\n**Error Code:** `13803`
\n SMS template does not exist: {sms_template_id}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call Queue does not exist: {callQueueId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_queue_policy:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_queue_policy:admin
/phone/call_queues/{callQueueId}/policies/{policyType}:
post:
tags:
- Call Queues
summary: Add a policy subsetting to a call queue
description: "Adds the policy subsetting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use set up shared access members. \n\n**Prerequisites** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: addCQPolicySubSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID that is retrievable the [List Call Queues](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listCallQueues) API.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: policyType
in: path
description: "This field corresponds to the policy sub-setting item you wish to add. \n\nAllowed values: `voice_mail`."
required: true
schema:
type: string
example: voice_mail
requestBody:
content:
application/json:
schema:
type: object
properties:
voicemail_access_members:
maxItems: 10
uniqueItems: true
type: array
description: The shared voicemail access member list. The number is limited to the minimum value of 10 or the number of allowed access members account setting.
items:
type: object
properties:
access_user_id:
type: string
description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or the unique identifier of the common area, depending on the access user type.
example: w0RChiauQeqRlv5fgxYULQ
access_user_type:
type: string
description: 'The extension type of the member to be added in the shared voicemail access member list. The default type will be user if empty. Allowed: user | commonArea.'
example: commonArea
enum:
- commonArea
- user
allow_download:
type: boolean
description: Whether the member has download permissions. The default is **false**.
example: false
allow_delete:
type: boolean
description: Whether the member has delete permissions. The default is **false**.
example: false
allow_sharing:
type: boolean
description: Whether the member has the permission to share. The default is **false**.
example: false
responses:
'201':
description: "**HTTP Status Code** `201` \n \nCreated Successfully."
content:
application/json:
schema:
type: object
properties:
voicemail_access_members:
maxItems: 10
uniqueItems: true
type: array
description: The shared access member list.
items:
allOf:
- type: object
properties:
access_user_id:
type: string
description: The member's ID in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or unique identifier of the common area depending on the access user type.
example: w0RChiauQeqRlv5fgxYULQ
access_user_type:
type: string
description: 'The extension type of the member to be added in the shared voicemail access member list. Allowed: user | commonArea.'
example: commonArea
enum:
- commonArea
- user
allow_download:
type: boolean
description: Whether the member has download permissions. The default is **false**.
example: false
allow_delete:
type: boolean
description: Whether the member has delete permissions. The default is **false**.
example: false
allow_sharing:
type: boolean
description: Whether the member has the permission to share. The default is **false**.
example: false
- type: object
properties:
shared_id:
type: string
description: The shared voicemail ID.
example: --e8ugg0SeS-9clgrDkn2w
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed.
\n**Error Code:** `400`
\n The number of items for voicemail_access_members must not exceed 10
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The Call Queue does not exist, callQueueId:{callQueueId}.
\n**Error Code:** `13001`
\n Invalid value for parameter {policyType}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue_policy:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue_policy:admin
delete:
tags:
- Call Queues
summary: Delete a CQ policy setting
description: "Use this API to remove the policy sub-setting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to remove shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: removeCQPolicySubSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID, retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: policyType
in: path
description: 'Corresponds to tbe policy sub-setting item you wish to remove. Allowed values: `voice_mail`'
required: true
schema:
type: string
example: voice_mail
- name: shared_ids
in: query
description: Comma separated list of shared IDs to remove. The number is limited to the minimum value of 10 or the number of allowed access members account setting.
required: true
schema:
maxItems: 20
type: array
example:
- 8_RkKw9OQ42oYsXqJJjs4A,4_RkKw9OQ42oYsXqJJjs4A
items:
type: string
example: 8_RkKw9OQ42oYsXqJJjs4A
responses:
'204':
description: "**HTTP Status Code:** `204` \n \nNo Content \n "
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The Call Queue does not exist, callQueueId:{callQueueId}.
\n**Error Code:** `13001`
\n Invalid value for parameter {policyType}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_policy:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_policy:admin
patch:
tags:
- Call Queues
summary: Update a call queue's policy subsetting
description: "Updates the policy subsetting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to update shared access members.\n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: updateCQPolicySubSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID that is retrievable from the [List Call Queues](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listCallQueues) API.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: policyType
in: path
description: 'The field that corresponds to the policy sub-setting item you wish to update. Allowed values: `voice_mail`.'
required: true
schema:
type: string
example: voice_mail
requestBody:
content:
application/json:
schema:
type: object
properties:
voicemail_access_members:
maxItems: 50
type: array
description: The shared voicemail access member list. The maximum number of allowed access members follows the setting in your account.
items:
allOf:
- type: object
properties:
access_user_id:
type: string
description: The member's ID or email in the shared voicemail access list determines the sharing or updating of access permissions. It must be the unique identifier of the user, or the unique identifier of the common area, depending on the access user type.
example: w0RChiauQeqRlv5fgxYULQ
access_user_type:
type: string
description: 'The extension type of the member to be added in the shared voicemail access member list. The default type will be user if empty. Allowed: user | commonArea.'
example: commonArea
enum:
- commonArea
- user
allow_download:
type: boolean
description: Whether the member has download permissions. The default is **false**.
example: false
allow_delete:
type: boolean
description: Whether the member has delete permissions. The default is **false**.
example: false
allow_sharing:
type: boolean
description: Whether the member has the permission to share. The default is **false**.
example: false
- type: object
properties:
shared_id:
type: string
description: The shared voicemail ID.
example: --e8ugg0SeS-9clgrDkn2w
responses:
'204':
description: '**HTTP Status Code:** `204` No Content. '
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The Call Queue does not exist, callQueueId:{callQueueId}.
\n**Error Code:** `13001`
\n Invalid value for parameter {policyType}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_queue_policy:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_queue_policy:admin
/phone/call_queues/{callQueueId}/recordings:
get:
tags:
- Call Queues
summary: Get call queue recordings
description: "Use this API to view [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091#h_cbc9f2a3-e06c-4daa-83d4-ddbceef9c77b) from the call queue.\n\n\n**Prerequisites:**\n\n* Pro or higher account with Zoom Phone license.\n* [Automatic call recordings](https://support.zoom.us/hc/en-us/articles/360033511872#h_fcb297bb-14e8-4094-91ca-dc61e1a18734) must be enabled in the Policy Settings for call queues. \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queue_recordings:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
operationId: getCallQueueRecordings
parameters:
- name: callQueueId
in: path
description: Unique identifier of the Call Queue.
required: true
schema:
type: string
example: 3PNsZB50TNev4pgBjtKeDw
- name: page_size
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 300
type: integer
example: 30
default: 30
- name: next_page_token
in: query
description: 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.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: from
in: query
description: 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. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.
required: false
schema:
type: string
format: date
example: '2020-10-31'
- name: to
in: query
description: '**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.'
required: false
schema:
type: string
format: date
example: '2021-12-31'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
from:
type: string
description: Start date.
example: '2022-03-26'
next_page_token:
type: string
description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: OvrVMfenVmKgsH0SqfWQ2jgUsHFGXeanCB2
page_size:
type: integer
description: The number of records returned within a single API call.
example: 30
recordings:
type: array
items:
type: object
properties:
callee_name:
type: string
description: Contact name of the callee.
example: APITA AUTO
callee_number:
type: string
description: Number of the callee.
example: '+12058945717'
callee_number_type:
type: string
description: "The callee's number type: \n* `1` — Internal number. \n* `2` — External number.\n* `3` — Customized emergency number."
example: '1'
enum:
- '1'
- '2'
- '3'
caller_name:
type: string
description: Name of the caller.
example: ZOOM_API Test
caller_number:
type: string
description: Phone number of the caller.
example: '+12055432724'
caller_number_type:
type: integer
description: "The caller's number type: \n* `1` — Internal number. \n* `2` — External number."
example: 1
enum:
- 1
- 2
date_time:
type: string
description: Date of the recording.
format: date
example: '2022-04-01'
direction:
type: string
description: Direction of call. The value of this field can be either `outbound` or `inbound`.
example: inbound
download_url:
type: string
description: URL using which the recording can be downloaded.
example: https://file.zoomdev.us/file?filename=call_recording_080e-2cba-4315-a963-81ce9635e_20220401031509.mp3&jwt=eyJhbGciNiJ9.eyJka0NzZiNjQyYjhkZjRlN2E3ZTgxNjU4MmEzMWQ4NjE3NjkyNjNjYmQ0NDJhM2QzYzY3NTZjIiwiaXNzIjoiwiYXVkIjoiZmlsZSIsImlhdCI6MTY0ODV4cCI6MTY0ODc4NTMxN30.azPOfIrODv6v6-7YWwvBWAqysJy_xe_FAI&path=zoomfs%3A%2F%2Fpbx-voice%2Frecording%2F2022%2F4%2F1%2FKxQKamXhQfWQs9BPdvDagA%2F8dunF6uUT1qW3KEe0sgaXA%2F08096c0e-2cba-4315-a963-81=e9635e%2Fcall_recording_080=c0e-2cba-4315-a963-813=635e_20220401031509.mp3
duration:
type: integer
description: Duration of the call.
example: 10
id:
type: string
description: Unique identifier of the recording.
example: 08096c0e2cba4315a963813d1ce9635e
to:
type: string
description: End date.
example: 2022-04-1
total_records:
type: integer
description: The total number of records returned for this API call.
example: 1
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read:list_call_queue_recordings:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_call_queue_recordings:admin
/phone/call_queues/{callQueueId}/settings:
get:
tags:
- Call Queues
summary: Get call queue settings
description: 'Returns call queue settings.
**Prerequisites:**
* Pro or higher account with Zoom Phone license.
* Account owner or admin permissions.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: getCallQueueSettings
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: VcuQ6M7JSKO6xOVQ4ZJ2Nw
- name: setting_type
in: query
description: 'The setting item to query. Defaults to `business_hours` if not provided. Allowed values: `holiday_hours`, `business_hours`, `break_hours`.'
required: false
schema:
type: string
example: business_hours
enum:
- holiday_hours
- business_hours
- break_hours
responses:
'200':
description: "**HTTP Status Code:** `200` \n \nCall queue settings returned."
content:
application/json:
schema:
description: The call queue settings.
oneOf:
- title: Holiday hour settings
type: object
properties:
holiday_hours:
type: array
description: The holiday list. The minimum is one item, and the maximum is 10 items.
items:
type: object
properties:
name:
type: string
description: The name of the holiday.
example: holiday name
from:
type: string
description: The holiday's start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
example: '2022-03-05T00:00:00Z'
to:
type: string
description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
example: '2022-03-06T00:00:00Z'
description: Each holiday.
description: Returned only when the setting type is `holiday_hours`.
- title: Business hour settings
type: object
properties:
business_hours_settings:
type: object
properties:
business_hours:
maxItems: 7
type: array
description: The business hours settings.
items:
type: object
properties:
from:
type: string
description: The business hours start time in `HH:mm` format.
example: 09:00
to:
type: string
description: The business hours end time in `HH:mm` format.
example: '18:00'
type:
type: integer
description: "The type of business hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours."
example: 1
enum:
- 0
- 1
- 2
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"
example: 7
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
business_hour_type:
type: integer
description: "The type of business hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Customized hours."
example: 2
enum:
- 1
- 2
description: The business hours settings.
description: Returned only when the setting type is `business_hours`.
- title: Break hour settings
type: object
properties:
break_hours:
type: array
description: The break hours list.
items:
type: object
properties:
break_hour_id:
type: string
description: The unique identifier of the break hour.
example: R4GeDFaLTpeQb1jPDCuPhA
break_hour_name:
maxLength: 255
minLength: 1
type: string
description: The name of the break hour.
example: Lunch Break
break_hour_type:
type: string
description: "The type of break hour schedule: \n* `every_business_day` — The break applies at the same time on every business day. \n* `custom_hours` — The break applies on specific days of the week with individually configured times."
example: every_business_day
enum:
- every_business_day
- custom_hours
break_hour_setting:
description: The break hour time configuration. The structure depends on the `break_hour_type` field.
oneOf:
- title: Every Business Day
required:
- from
- to
type: object
properties:
from:
type: string
description: The start time of the break in `HH:mm` format (24-hour clock). For example, `12:00`.
example: '12:00'
to:
type: string
description: The end time of the break in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time.
example: '13:00'
description: Only returned when `break_hour_type` is `every_business_day`. Defines a single time range that applies to all business days.
- title: Custom Hours
required:
- days
type: object
properties:
days:
maxItems: 7
type: array
description: The list of days with configured break times. Only includes days that have break hours enabled.
items:
required:
- from
- to
- weekday
type: object
properties:
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"
example: 7
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
enable:
type: boolean
description: Whether the break hour is enabled on this day.
example: true
from:
type: string
description: The start time of the break on this day in `HH:mm` format (24-hour clock). For example, `12:00`.
example: '12:00'
to:
type: string
description: The end time of the break on this day in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time.
example: '13:00'
description: Only returned when `break_hour_type` is `custom_hours`. Lists the specific days of the week on which the break is active, along with their individual time ranges.
description: Returned only when the setting type is `break_hours`.
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call Queue does not exist: {callQueueId}.
\n"
security:
- openapi_oauth:
- phone:read:admin
- phone:read:call_queue_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:call_queue_setting:admin
/phone/call_queues/{callQueueId}/settings/{settingType}:
post:
tags:
- Call Queues
summary: Add call queue setting
description: 'Adds a call queue setting according to the setting type.
**Prerequisites**
* A Pro or higher account with a Zoom Phone license.
* Account owner or admin permissions.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: addCallQueueSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: VcuQ6M7JSKO6xOVQ4ZJ2Nw
- name: settingType
in: path
description: 'The setting type that corresponds to the setting item you want to add. Allowed values: `holiday_hours`, `break_hours`.'
required: true
schema:
type: string
example: holiday_hours
enum:
- holiday_hours
- break_hours
requestBody:
content:
application/json:
schema:
oneOf:
- title: Holiday hour settings
type: object
properties:
holiday_hours:
type: object
properties:
holidays:
maxItems: 10
minItems: 1
type: array
description: The holiday list. The minimum is one item and the maximum is 10 items.
items:
required:
- from
- name
- to
type: object
properties:
name:
type: string
description: The name of the holiday.
example: holiday name
from:
type: string
description: The holiday's start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
format: date-time
example: '2022-03-05T00:00:00Z'
to:
type: string
description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
format: date-time
example: '2022-03-06T00:00:00Z'
description: Each holiday.
description: This field is only required when the setting type is `holiday_hours`.
description: Use this schema when the setting type is `holiday_hours`.
- title: Break hour settings
type: object
properties:
break_hours:
type: object
properties:
break_hour_settings:
maxItems: 5
type: array
description: The list of break hour settings. This field is only required when the setting type is `break_hours`.
items:
required:
- break_hour_name
- break_hour_type
type: object
properties:
break_hour_name:
maxLength: 255
minLength: 1
type: string
description: The name of the break hour.
example: Lunch Break
break_hour_type:
type: string
description: "The type of break hour schedule: \n* `every_business_day` — The break applies at the same time on every business day. \n* `custom_hours` — The break applies on specific days of the week with individually configured times."
example: every_business_day
enum:
- every_business_day
- custom_hours
break_hour_setting:
description: The break hour time configuration. The structure depends on the `break_hour_type` field.
oneOf:
- title: Every Business Day
required:
- from
- to
type: object
properties:
from:
type: string
description: The start time of the break in HH:mm format (24-hour clock). For example, `12:00`.
example: '12:00'
to:
type: string
description: The end time of the break in HH:mm format (24-hour clock). For example, `13:00`. Must be after the `from` time.
example: '13:00'
description: Only required when `break_hour_type` is `every_business_day`. Defines a single time range that applies to all business days.
- title: Custom Hours
required:
- days
type: object
properties:
days:
maxItems: 7
type: array
description: The list of days with configured break times. Only includes days that have break hours enabled.
items:
required:
- from
- to
- weekday
type: object
properties:
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"
example: 7
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
enable:
type: boolean
description: Whether the break hour is enabled on this day.
example: true
from:
type: string
description: The start time of the break on this day in HH:mm format (24-hour clock). For example, `12:00`.
example: '12:00'
to:
type: string
description: The end time of the break on this day in HH:mm format (24-hour clock). For example, `13:00`. Must be after the `from` time.
example: '13:00'
description: Only required when `break_hour_type` is `custom_hours`. Lists the specific days of the week on which the break is active, along with their individual time ranges.
description: The list of break hours. This field is only required when the setting type is `break_hours`.
description: Use this schema when the setting type is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
responses:
'201':
description: "**HTTP Status Code:** `201` **Created** \n \n\nCreated successfully."
content:
application/json:
schema:
description: The call queue setting created according to the setting type.
oneOf:
- title: Holiday hour settings
type: object
properties:
holiday_hours:
type: object
properties:
holidays:
type: array
description: The list of holidays. Returned only when the setting type is `holiday_hours`.
items:
type: object
properties:
holiday_id:
type: string
description: The holiday ID.
example: ULfeE4mgSImyelNmTekUfg
name:
type: string
description: The name of the holiday.
example: test
description: The holiday hours. Returned only when the setting type is `holiday_hours`.
description: Returned only when the setting type is `holiday_hours`.
- title: Break hour settings
type: object
properties:
break_hours:
type: object
properties:
break_hour_settings:
maxItems: 5
type: array
description: The list of break hour settings. Returned only when the setting type is `break_hours`.
items:
required:
- break_hour_id
- break_hour_name
type: object
properties:
break_hour_id:
type: string
description: The unique identifier of the break hour.
example: R4GeDFaLTpeQb1jPDCuPhA
break_hour_name:
maxLength: 255
minLength: 1
type: string
description: The name of the break hour.
example: Lunch Break
description: The list of break hours. Returned only when the setting type is `break_hours`.
description: Returned only when the setting type is `break_hours`.
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call queue does not exist: {callQueueId}.
\n"
security:
- openapi_oauth:
- phone:write:admin
- phone:write:call_queue_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:call_queue_setting:admin
delete:
tags:
- Call Queues
summary: Delete call queue setting
description: 'Delete the call queue setting by the setting type.
**Prerequisites**
* A Pro or higher account with a Zoom Phone license.
* Account owner or admin permissions.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: deleteCallQueueSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: VcuQ6M7JSKO6xOVQ4ZJ2Nw
- name: settingType
in: path
description: 'The setting type to delete. Allowed values: `holiday_hours`, `break_hours`.'
required: true
schema:
type: string
example: holiday_hours
enum:
- holiday_hours
- break_hours
- name: holiday_hour_id
in: query
description: The holiday hour ID. Required when `settingType` is `holiday_hours`.
required: false
schema:
type: string
example: TNxfEp2WT9emyCsAQt4qnA
- name: break_hour_id
in: query
description: The break hour ID. Required when `settingType` is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
required: false
schema:
type: string
example: ULfeE4mgSImyelNmTekUfg
responses:
'204':
description: "**HTTP Status Code:** `204` **No Content** \n \n"
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15102`
\n Holiday hour does not exist: {holidayHourId}.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call queue does not exist: {callQueueId}.
\n"
security:
- openapi_oauth:
- phone:write:admin
- phone:delete:call_queue_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:call_queue_setting:admin
patch:
tags:
- Call Queues
summary: Update call queue setting
description: 'Update the call queue setting according to the setting type.
**Prerequisites**
* A Pro or higher account with a Zoom Phone license.
* Account owner or admin permissions.
**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`
**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_setting:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`'
operationId: updateCallQueueSetting
parameters:
- name: callQueueId
in: path
description: The call queue ID.
required: true
schema:
type: string
example: VcuQ6M7JSKO6xOVQ4ZJ2Nw
- name: settingType
in: path
description: 'The setting type that corresponds to the setting item to modify. Allowed values: `holiday_hours`, `business_hours`, `break_hours`.'
required: true
schema:
type: string
example: business_hours
enum:
- holiday_hours
- business_hours
- break_hours
requestBody:
content:
application/json:
schema:
oneOf:
- title: Holiday hour settings
type: object
properties:
holiday_hours:
type: object
properties:
holidays:
maxItems: 10
minItems: 1
type: array
description: The holiday list. The minimum is one item, and the maximum is 10 items.
items:
type: object
properties:
name:
type: string
description: The name of the holiday.
example: holiday name
from:
type: string
description: The holiday's start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
example: '2022-03-05T00:00:00Z'
to:
type: string
description: The holiday's end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.
example: '2022-03-06T00:00:00Z'
description: Each holiday.
description: This field is only required for the `holiday_hours` setting type.
description: Use this schema when the setting type is `holiday_hours`.
- title: Business hour settings
type: object
properties:
business_hours_settings:
type: object
properties:
business_hours:
maxItems: 7
type: array
description: The business hours settings.
items:
type: object
properties:
from:
type: string
description: The business hours start time in `HH:mm` format.
example: 09:00
to:
type: string
description: The business hours end time in `HH:mm` format.
example: '18:00'
type:
type: integer
description: "The type of business hours: \n* `0` — Disabled. \n* `1` — 24 hours. \n* `2` — Customized hours."
example: 1
enum:
- 0
- 1
- 2
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday. \n* `2` — Monday. \n* `3` — Tuesday. \n* `4` — Wednesday. \n* `5` — Thursday. \n* `6` — Friday. \n* `7` — Saturday."
example: 7
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
business_hour_type:
type: integer
description: "The type of business hours: \n* `1` — 24 hours, 7 days a week. \n* `2` — Customized hours."
example: 2
enum:
- 1
- 2
description: The business hours settings.
description: Use this schema when the setting type is `business_hours`.
- title: Break hour settings
type: object
properties:
break_hours:
type: object
properties:
break_hour_settings:
maxItems: 5
type: array
description: The list of break hour configurations.
items:
type: object
properties:
break_hour_id:
type: string
description: The unique identifier of the break hour.
example: R4GeDFaLTpeQb1jPDCuPhA
break_hour_name:
maxLength: 255
minLength: 1
type: string
description: The name of the break hour.
example: Lunch Break
break_hour_type:
type: string
description: "The type of break hour schedule: \n* `every_business_day` — The break applies at the same time on every business day. \n* `custom_hours` — The break applies on specific days of the week with individually configured times."
example: every_business_day
enum:
- every_business_day
- custom_hours
break_hour_setting:
description: The break hour time configuration. The structure depends on the `break_hour_type` field.
oneOf:
- title: Every Business Day
required:
- from
- to
type: object
properties:
from:
type: string
description: The start time of the break in `HH:mm` format (24-hour clock). For example, `12:00`.
example: '12:00'
to:
type: string
description: The end time of the break in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time.
example: '13:00'
description: Only required when `break_hour_type` is `every_business_day`. Defines a single time range that applies to all business days.
- title: Custom Hours
required:
- days
type: object
properties:
days:
maxItems: 7
type: array
description: The list of days with configured break times. Only includes days that have break hours enabled.
items:
required:
- from
- to
- weekday
type: object
properties:
weekday:
type: integer
description: "The day of the week: \n* `1` — Sunday. \n* `2` — Monday. \n* `3` — Tuesday. \n* `4` — Wednesday. \n* `5` — Thursday. \n* `6` — Friday. \n* `7` — Saturday."
example: 7
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
enable:
type: boolean
description: Whether the break hour is enabled on this day.
example: true
from:
type: string
description: The start time of the break on this day in `HH:mm` format (24-hour clock). For example, `12:00`.
example: '12:00'
to:
type: string
description: The end time of the break on this day in `HH:mm` format (24-hour clock). For example, `13:00`. Must be after the `from` time.
example: '13:00'
description: Only required when `break_hour_type` is `custom_hours`. Lists the specific days of the week on which the break is active, along with their individual time ranges.
description: The break hours settings.
description: Use this schema when the setting type is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
responses:
'204':
description: "**HTTP Status Code:** `204` **No Content** \n \n"
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `15101`
\n Break hour does not exist: {breakHourId}.
\n**Error Code:** `15102`
\n Holiday hour does not exist: {holidayHourId}.
\n**Error Code:** `15104`
\n The {hour_type} cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call queue does not exist: {callQueueId}.
\n"
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_queue_setting:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_queue_setting:admin
components:
securitySchemes:
openapi_authorization:
type: apiKey
name: Authorization
in: header
openapi_oauth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /
tokenUrl: ''
refreshUrl: ''
scopes:
phone:read:admin: phone:read:admin
phone:read:list_account_settings:admin: phone:read:list_account_settings:admin
phone:write:admin: phone:write:admin
phone:write:customized_number:admin: phone:write:customized_number:admin
phone:read:list_customized_number:admin: phone:read:list_customized_number:admin
phone:delete:customized_number:admin: phone:delete:customized_number:admin
phone:write:alert_setting:admin: phone:write:alert_setting:admin
phone:read:list_alert_settings:admin: phone:read:list_alert_settings:admin
phone:read:alert_setting:admin: phone:read:alert_setting:admin
phone:patch:alert_setting:admin: phone:patch:alert_setting:admin
phone:delete:alert_setting:admin: phone:delete:alert_setting:admin
phone:read: phone:read
phone:read:audio: phone:read:audio
phone:read:audio:admin: phone:read:audio:admin
phone:write: phone:write
phone:delete:audio: phone:delete:audio
phone:delete:audio:admin: phone:delete:audio:admin
phone:update:audio: phone:update:audio
phone:update:audio:admin: phone:update:audio:admin
phone:read:list_audios: phone:read:list_audios
phone:read:list_audios:admin: phone:read:list_audios:admin
phone:write:audio: phone:write:audio
phone:write:audio:admin: phone:write:audio:admin
phone:write:batch_audios: phone:write:batch_audios
phone:write:batch_audios:admin: phone:write:batch_audios:admin
phone:read:list_auto_receptionists:admin: phone:read:list_auto_receptionists:admin
phone:write:auto_receptionist:admin: phone:write:auto_receptionist:admin
phone:delete:auto_receptionist:admin: phone:delete:auto_receptionist:admin
phone:update:auto_receptionist:admin: phone:update:auto_receptionist:admin
phone:read:auto_receptionist:admin: phone:read:auto_receptionist:admin
phone:read:auto_receptionist_call_handling_setting:admin: phone:read:auto_receptionist_call_handling_setting:admin
phone:update:auto_receptionist_call_handling_setting:admin: phone:update:auto_receptionist_call_handling_setting:admin
phone:delete:auto_receptionist_number:admin: phone:delete:auto_receptionist_number:admin
phone:write:auto_receptionist_number:admin: phone:write:auto_receptionist_number:admin
phone:update:auto_receptionist_policy:admin: phone:update:auto_receptionist_policy:admin
phone:read:auto_receptionist_policy:admin: phone:read:auto_receptionist_policy:admin
phone:delete:auto_receptionist_policy:admin: phone:delete:auto_receptionist_policy:admin
phone:write:auto_receptionist_policy:admin: phone:write:auto_receptionist_policy:admin
phone:read:auto_receptionist_setting:admin: phone:read:auto_receptionist_setting:admin
phone:write:auto_receptionist_setting:admin: phone:write:auto_receptionist_setting:admin
phone:update:auto_receptionist_setting:admin: phone:update:auto_receptionist_setting:admin
phone:delete:auto_receptionist_setting:admin: phone:delete:auto_receptionist_setting:admin
phone:read:list_billing_accounts:admin: phone:read:list_billing_accounts:admin
phone:read:billing_account:admin: phone:read:billing_account:admin
phone:write:blocked_list:admin: phone:write:blocked_list:admin
phone:read:list_blocked_lists:admin: phone:read:list_blocked_lists:admin
phone:delete:blocked_list:admin: phone:delete:blocked_list:admin
phone:read:blocked_list:admin: phone:read:blocked_list:admin
phone:update:blocked_list:admin: phone:update:blocked_list:admin
phone:read:list_call_handling_settings:admin: phone:read:list_call_handling_settings:admin
phone:update:call_handling_setting:admin: phone:update:call_handling_setting:admin
phone:delete:call_handling_setting:admin: phone:delete:call_handling_setting:admin
phone:write:call_handling_setting:admin: phone:write:call_handling_setting:admin
phone_call_log:read: phone_call_log:read
phone_call_log:read:admin: phone_call_log:read:admin
phone:read:call_log:admin: phone:read:call_log:admin
phone:read:list_call_logs:admin: phone:read:list_call_logs:admin
phone:update:call_log:admin: phone:update:call_log:admin
phone:read:ai_call_summary: phone:read:ai_call_summary
phone:read:ai_call_summary:admin: phone:read:ai_call_summary:admin
phone:read:list_call_logs: phone:read:list_call_logs
phone_call_log:write: phone_call_log:write
phone_call_log:write:admin: phone_call_log:write:admin
phone:delete:call_log: phone:delete:call_log
phone:delete:call_log:admin: phone:delete:call_log:admin
phone:read:list_call_queues:admin: phone:read:list_call_queues:admin
phone:write:call_queue:admin: phone:write:call_queue:admin
phone:delete:call_queue:admin: phone:delete:call_queue:admin
phone:update:call_queue:admin: phone:update:call_queue:admin
phone:read:call_queue:admin: phone:read:call_queue:admin
phone:read:call_queue_call_handling_setting:admin: phone:read:call_queue_call_handling_setting:admin
phone:update:call_queue_call_handling_setting:admin: phone:update:call_queue_call_handling_setting:admin
phone:read:call_queue_custom_group:admin: phone:read:call_queue_custom_group:admin
phone:write:call_queue_custom_group:admin: phone:write:call_queue_custom_group:admin
phone:update:call_queue_custom_group:admin: phone:update:call_queue_custom_group:admin
phone:delete:call_queue_custom_group:admin: phone:delete:call_queue_custom_group:admin
phone:delete:call_queue_custom_group:master: phone:delete:call_queue_custom_group:master
phone:master: phone:master
phone:read:call_queue_custom_group:master: phone:read:call_queue_custom_group:master
phone:write:call_queue_custom_group_member:admin: phone:write:call_queue_custom_group_member:admin
phone:delete:call_queue_custom_group_member:admin: phone:delete:call_queue_custom_group_member:admin
phone:write:call_queue_member:admin: phone:write:call_queue_member:admin
phone:delete:call_queue_member:admin: phone:delete:call_queue_member:admin
phone:read:list_call_queue_members:admin: phone:read:list_call_queue_members:admin
phone:write:call_queue_number:admin: phone:write:call_queue_number:admin
phone:delete:call_queue_number:admin: phone:delete:call_queue_number:admin
phone:read:call_queue_policy:admin: phone:read:call_queue_policy:admin
phone:update:call_queue_policy:admin: phone:update:call_queue_policy:admin
phone:write:call_queue_policy:admin: phone:write:call_queue_policy:admin
phone:delete:call_queue_policy:admin: phone:delete:call_queue_policy:admin
phone:read:list_call_queue_recordings:admin: phone:read:list_call_queue_recordings:admin
phone:read:call_queue_setting:admin: phone:read:call_queue_setting:admin
phone:write:call_queue_setting:admin: phone:write:call_queue_setting:admin
phone:delete:call_queue_setting:admin: phone:delete:call_queue_setting:admin
phone:update:call_queue_setting:admin: phone:update:call_queue_setting:admin
phone:update:carrier_number:admin: phone:update:carrier_number:admin
phone:write:carrier_number:admin: phone:write:carrier_number:admin
phone:read:list_carrier_numbers:admin: phone:read:list_carrier_numbers:admin
phone:delete:carrier_number:admin: phone:delete:carrier_number:admin
phone:write:common_area:admin: phone:write:common_area:admin
phone:read:common_area:admin: phone:read:common_area:admin
phone:read:list_common_area_activation_codes:admin: phone:read:list_common_area_activation_codes:admin
phone:write:apply_template_to_common_areas:admin: phone:write:apply_template_to_common_areas:admin
phone:delete:common_area:admin: phone:delete:common_area:admin
phone:update:common_area:admin: phone:update:common_area:admin
phone:read:common_area_call_handling_setting:admin: phone:read:common_area_call_handling_setting:admin
phone:update:common_area_call_handling_setting:admin: phone:update:common_area_call_handling_setting:admin
phone:write:common_area_calling_plan:admin: phone:write:common_area_calling_plan:admin
phone:delete:common_area_calling_plan:admin: phone:delete:common_area_calling_plan:admin
phone:write:common_area_number:admin: phone:write:common_area_number:admin
phone:delete:common_area_number:admin: phone:delete:common_area_number:admin
phone:read:list_common_area_settings:admin: phone:read:list_common_area_settings:admin
phone:update:common_area_setting:admin: phone:update:common_area_setting:admin
phone:delete:common_area_setting:admin: phone:delete:common_area_setting:admin
phone:write:common_area_setting:admin: phone:write:common_area_setting:admin
phone:read:call_qos:admin: phone:read:call_qos:admin
phone:read:default_emergency_address:admin: phone:read:default_emergency_address:admin
phone:read:detectable_personal_location:admin: phone:read:detectable_personal_location:admin
phone:read:location_sharing_permission:admin: phone:read:location_sharing_permission:admin
phone:read:nomadic_emergency_services:admin: phone:read:nomadic_emergency_services:admin
phone:read:realtime_location_devices:admin: phone:read:realtime_location_devices:admin
phone:read:realtime_location_users:admin: phone:read:realtime_location_users:admin
phone:read:list_tracked_locations:admin: phone:read:list_tracked_locations:admin
phone:update:device_line_keys: phone:update:device_line_keys
phone:update:device_line_keys:admin: phone:update:device_line_keys:admin
phone:read:device_line_keys: phone:read:device_line_keys
phone:read:device_line_keys:admin: phone:read:device_line_keys:admin
phone:delete:directory:admin: phone:delete:directory:admin
phone:read:directory:admin: phone:read:directory:admin
phone:write:directory:admin: phone:write:directory:admin
phone:write:emergency_address:admin: phone:write:emergency_address:admin
phone:read:list_emergency_addresses:admin: phone:read:list_emergency_addresses:admin
phone:read:emergency_address:admin: phone:read:emergency_address:admin
phone:delete:emergency_address:admin: phone:delete:emergency_address:admin
phone:update:emergency_address:admin: phone:update:emergency_address:admin
phone:write:batch_emergency_locations:admin: phone:write:batch_emergency_locations:admin
phone:read:list_emergency_locations:admin: phone:read:list_emergency_locations:admin
phone:write:emergency_location:admin: phone:write:emergency_location:admin
phone:read:emergency_location:admin: phone:read:emergency_location:admin
phone:update:emergency_location:admin: phone:update:emergency_location:admin
phone:delete:emergency_location:admin: phone:delete:emergency_location:admin
phone:write:external_contact:admin: phone:write:external_contact:admin
phone:read:list_external_contacts:admin: phone:read:list_external_contacts:admin
phone:delete:external_contact:admin: phone:delete:external_contact:admin
phone:read:external_contact:admin: phone:read:external_contact:admin
phone:update:external_contact:admin: phone:update:external_contact:admin
phone:write:send_fax: phone:write:send_fax
phone:write:send_fax:admin: phone:write:send_fax:admin
phone:read:list_fax_log: phone:read:list_fax_log
phone:read:list_fax_log:admin: phone:read:list_fax_log:admin
phone:read:fax_log:admin: phone:read:fax_log:admin
phone:read:fax_log: phone:read:fax_log
phone:delete:fax_log: phone:delete:fax_log
phone:delete:fax_log:admin: phone:delete:fax_log:admin
phone:read:list_firmware_update_rules:admin: phone:read:list_firmware_update_rules:admin
phone:write:firmware_update_rule:admin: phone:write:firmware_update_rule:admin
phone:delete:firmware_update_rule:admin: phone:delete:firmware_update_rule:admin
phone:update:firmware_update_rule:admin: phone:update:firmware_update_rule:admin
phone:read:firmware_update_rule:admin: phone:read:firmware_update_rule:admin
phone:read:list_firmwares:admin: phone:read:list_firmwares:admin
phone:read:list_call_pickup_groups:admin: phone:read:list_call_pickup_groups:admin
phone:write:call_pickup_group:admin: phone:write:call_pickup_group:admin
phone:read:call_pickup_group:admin: phone:read:call_pickup_group:admin
phone:update:call_pickup_group:admin: phone:update:call_pickup_group:admin
phone:delete:call_pickup_group:admin: phone:delete:call_pickup_group:admin
phone:write:call_pickup_group_member:admin: phone:write:call_pickup_group_member:admin
phone:read:call_pickup_group_member:admin: phone:read:call_pickup_group_member:admin
phone:delete:call_pickup_group_member:admin: phone:delete:call_pickup_group_member:admin
phone:update:group_policy:admin: phone:update:group_policy:admin
phone:read:group_policy:admin: phone:read:group_policy:admin
phone:read:group_setting:admin: phone:read:group_setting:admin
phone:read:auto_receptionist_ivr:admin: phone:read:auto_receptionist_ivr:admin
phone:update:auto_receptionist_ivr:admin: phone:update:auto_receptionist_ivr:admin
phone:read:list_extension_inbound_block_rules:admin: phone:read:list_extension_inbound_block_rules:admin
phone:read:list_extension_inbound_block_rules: phone:read:list_extension_inbound_block_rules
phone:delete:extension_inbound_block_rule:admin: phone:delete:extension_inbound_block_rule:admin
phone:delete:extension_inbound_block_rule: phone:delete:extension_inbound_block_rule
phone:write:extension_inbound_block_rule:admin: phone:write:extension_inbound_block_rule:admin
phone:write:extension_inbound_block_rule: phone:write:extension_inbound_block_rule
phone:delete:extension_inbound_block_rule_stat:admin: phone:delete:extension_inbound_block_rule_stat:admin
phone:read:list_extension_inbound_block_rules_stat:admin: phone:read:list_extension_inbound_block_rules_stat:admin
phone:update:inbound_blocked_for_all:admin: phone:update:inbound_blocked_for_all:admin
phone:delete:inbound_block_rule:admin: phone:delete:inbound_block_rule:admin
phone:read:list_inbound_block_rules:admin: phone:read:list_inbound_block_rules:admin
phone:write:inbound_block_rule:admin: phone:write:inbound_block_rule:admin
phone:update:inbound_block_rule:admin: phone:update:inbound_block_rule:admin
phone:update:line_keys: phone:update:line_keys
phone:update:line_keys:admin: phone:update:line_keys:admin
phone:read:line_keys: phone:read:line_keys
phone:read:line_keys:admin: phone:read:line_keys:admin
phone:delete:line_keys: phone:delete:line_keys
phone:delete:line_keys:admin: phone:delete:line_keys:admin
phone:read:list_monitoring_groups:admin: phone:read:list_monitoring_groups:admin
phone:write:monitoring_group:admin: phone:write:monitoring_group:admin
phone:delete:monitoring_group:admin: phone:delete:monitoring_group:admin
phone:update:monitoring_group:admin: phone:update:monitoring_group:admin
phone:read:monitoring_group:admin: phone:read:monitoring_group:admin
phone:read:list_monitoring_group_members:admin: phone:read:list_monitoring_group_members:admin
phone:write:monitoring_group_member:admin: phone:write:monitoring_group_member:admin
phone:delete:monitoring_group_member:admin: phone:delete:monitoring_group_member:admin
phone:read:common_area_outbound_calling_rule:admin: phone:read:common_area_outbound_calling_rule:admin
phone:update:common_area_outbound_calling_rule:admin: phone:update:common_area_outbound_calling_rule:admin
phone:write:common_area_outbound_calling_rule:admin: phone:write:common_area_outbound_calling_rule:admin
phone:delete:common_area_outbound_calling_rule:admin: phone:delete:common_area_outbound_calling_rule:admin
phone:read:list_outbound_calling_rules:admin: phone:read:list_outbound_calling_rules:admin
phone:update:outbound_calling_rule:admin: phone:update:outbound_calling_rule:admin
phone:write:outbound_calling_rule:admin: phone:write:outbound_calling_rule:admin
phone:delete:outbound_calling_rule:admin: phone:delete:outbound_calling_rule:admin
phone:update:site_outbound_calling_rule:admin: phone:update:site_outbound_calling_rule:admin
phone:read:site_outbound_calling_rule:admin: phone:read:site_outbound_calling_rule:admin
phone:write:site_outbound_calling_rule:admin: phone:write:site_outbound_calling_rule:admin
phone:delete:site_outbound_calling_rule:admin: phone:delete:site_outbound_calling_rule:admin
phone:update:user_outbound_calling_rule:admin: phone:update:user_outbound_calling_rule:admin
phone:read:user_outbound_calling_rule:admin: phone:read:user_outbound_calling_rule:admin
phone:write:user_outbound_calling_rule:admin: phone:write:user_outbound_calling_rule:admin
phone:delete:user_outbound_calling_rule:admin: phone:delete:user_outbound_calling_rule:admin
phone:read:list_devices:admin: phone:read:list_devices:admin
phone:write:device:admin: phone:write:device:admin
phone:write:sync_device:admin: phone:write:sync_device:admin
phone:update:device:admin: phone:update:device:admin
phone:delete:device:admin: phone:delete:device:admin
phone:read:device:admin: phone:read:device:admin
phone:write:device_extension:admin: phone:write:device_extension:admin
phone:delete:device_extension:admin: phone:delete:device_extension:admin
phone:update:device_provision_template:admin: phone:update:device_provision_template:admin
phone:write:reboot_device:admin: phone:write:reboot_device:admin
phone:write:byo_carrier_number:admin: phone:write:byo_carrier_number:admin
phone:delete:number:admin: phone:delete:number:admin
phone:read:list_numbers:admin: phone:read:list_numbers:admin
phone:update:site_number:admin: phone:update:site_number:admin
phone:read:numbers:admin: phone:read:numbers:admin
phone:update:number:admin: phone:update:number:admin
phone:write:user_number: phone:write:user_number
phone:write:user_number:admin: phone:write:user_number:admin
phone:delete:user_number: phone:delete:user_number
phone:delete:user_number:admin: phone:delete:user_number:admin
phone:read:list_calling_plans:admin: phone:read:list_calling_plans:admin
phone:read:list_roles:admin: phone:read:list_roles:admin
phone:write:role:admin: phone:write:role:admin
phone:update:role:admin: phone:update:role:admin
phone:read:role:admin: phone:read:role:admin
phone:delete:role:admin: phone:delete:role:admin
phone:read:role_member:admin: phone:read:role_member:admin
phone:write:role_member:admin: phone:write:role_member:admin
phone:delete:role_member:admin: phone:delete:role_member:admin
phone:write:private_directory_member:admin: phone:write:private_directory_member:admin
phone:read:list_private_directory_members:admin: phone:read:list_private_directory_members:admin
phone:update:private_directory_member:admin: phone:update:private_directory_member:admin
phone:delete:private_directory_member:admin: phone:delete:private_directory_member:admin
phone_peering:read:admin: phone_peering:read:admin
phone:read:list_peering_numbers:admin: phone:read:list_peering_numbers:admin
phone_peering:write:admin: phone_peering:write:admin
phone:write:peering_number:admin: phone:write:peering_number:admin
phone:delete:peering_number:admin: phone:delete:peering_number:admin
phone:update:peering_number:admin: phone:update:peering_number:admin
phone:write:provision_template:admin: phone:write:provision_template:admin
phone:read:list_provision_templates:admin: phone:read:list_provision_templates:admin
phone:update:provision_template:admin: phone:update:provision_template:admin
phone:read:provision_template:admin: phone:read:provision_template:admin
phone:delete:provision_template:admin: phone:delete:provision_template:admin
phone_recording:read: phone_recording:read
phone_recording:read:admin: phone_recording:read:admin
phone:read:call_recording: phone:read:call_recording
phone:read:call_recording:admin: phone:read:call_recording:admin
phone:read:recording_transcript: phone:read:recording_transcript
phone:read:recording_transcript:admin: phone:read:recording_transcript:admin
phone:read:list_call_recordings:admin: phone:read:list_call_recordings:admin
phone_recording:write: phone_recording:write
phone_recording:write:admin: phone_recording:write:admin
phone:update:call_recording: phone:update:call_recording
phone:update:call_recording:admin: phone:update:call_recording:admin
phone:delete:call_recording: phone:delete:call_recording
phone:delete:call_recording:admin: phone:delete:call_recording:admin
phone:read:list_recordings: phone:read:list_recordings
phone:read:list_recordings:admin: phone:read:list_recordings:admin
phone:read:call_charges:admin: phone:read:call_charges:admin
phone:read:fax_charges:admin: phone:read:fax_charges:admin
phone:read:operation_logs:admin: phone:read:operation_logs:admin
phone:read:sms_charges:admin: phone:read:sms_charges:admin
phone:read:list_routing_rules:admin: phone:read:list_routing_rules:admin
phone:write:routing_rule:admin: phone:write:routing_rule:admin
phone:update:routing_rule:admin: phone:update:routing_rule:admin
phone:read:routing_rule:admin: phone:read:routing_rule:admin
phone:delete:routing_rule:admin: phone:delete:routing_rule:admin
phone_sms:write: phone_sms:write
phone_sms:write:admin: phone_sms:write:admin
phone:read:sms_message: phone:read:sms_message
phone:read:sms_message:admin: phone:read:sms_message:admin
phone_sms:read: phone_sms:read
phone_sms:read:admin: phone_sms:read:admin
phone:read:list_sms_sessions: phone:read:list_sms_sessions
phone:read:list_sms_sessions:admin: phone:read:list_sms_sessions:admin
phone:read:sms_session: phone:read:sms_session
phone:read:sms_session:admin: phone:read:sms_session:admin
phone:read:list_sms_campaigns:admin: phone:read:list_sms_campaigns:admin
phone:read:sms_campaign:admin: phone:read:sms_campaign:admin
phone:write:sms_campaign_number:admin: phone:write:sms_campaign_number:admin
phone:read:sms_campaign_number_opt_status:admin: phone:read:sms_campaign_number_opt_status:admin
phone:update:sms_campaign_number_opt_status:admin: phone:update:sms_campaign_number_opt_status:admin
phone:delete:sms_campaign_number:admin: phone:delete:sms_campaign_number:admin
phone:read:sms_campaign_number_opt_status: phone:read:sms_campaign_number_opt_status
phone:read:sms_consent_number_opt_status:admin: phone:read:sms_consent_number_opt_status:admin
phone:write:setting_template:admin: phone:write:setting_template:admin
phone:read:list_setting_templates:admin: phone:read:list_setting_templates:admin
phone:update:setting_template:admin: phone:update:setting_template:admin
phone:read:setting_template:admin: phone:read:setting_template:admin
phone:update:policy:admin: phone:update:policy:admin
phone:read:policy:admin: phone:read:policy:admin
phone:read:list_ported_numbers:admin: phone:read:list_ported_numbers:admin
phone:read:ported_number:admin: phone:read:ported_number:admin
phone:update:settings:admin: phone:update:settings:admin
phone:read:settings:admin: phone:read:settings:admin
phone:read:list_sip_groups:admin: phone:read:list_sip_groups:admin
phone:read:list_sip_trunks:admin: phone:read:list_sip_trunks:admin
phone:read:list_shared_line_appearances:admin: phone:read:list_shared_line_appearances:admin
phone:read:list_shared_line_groups:admin: phone:read:list_shared_line_groups:admin
phone:write:shared_line_group:admin: phone:write:shared_line_group:admin
phone:read:shared_line_group:admin: phone:read:shared_line_group:admin
phone:read:shared_line_group_call_handling_setting:admin: phone:read:shared_line_group_call_handling_setting:admin
phone:update:shared_line_group_call_handling_setting:admin: phone:update:shared_line_group_call_handling_setting:admin
phone:read:shared_line_group_policy:admin: phone:read:shared_line_group_policy:admin
phone:update:shared_line_group_policy:admin: phone:update:shared_line_group_policy:admin
phone:read:shared_line_group_setting:admin: phone:read:shared_line_group_setting:admin
phone:update:shared_line_group_setting:admin: phone:update:shared_line_group_setting:admin
phone:delete:shared_line_group_setting:admin: phone:delete:shared_line_group_setting:admin
phone:write:shared_line_group_setting:admin: phone:write:shared_line_group_setting:admin
phone:update:shared_line_group:admin: phone:update:shared_line_group:admin
phone:delete:shared_line_group:admin: phone:delete:shared_line_group:admin
phone:delete:shared_line_member:admin: phone:delete:shared_line_member:admin
phone:write:shared_line_member:admin: phone:write:shared_line_member:admin
phone:delete:shared_line_group_number:admin: phone:delete:shared_line_group_number:admin
phone:write:shared_line_group_number:admin: phone:write:shared_line_group_number:admin
phone:delete:shared_line_group_policy:admin: phone:delete:shared_line_group_policy:admin
phone:write:shared_line_group_policy:admin: phone:write:shared_line_group_policy:admin
phone:read:list_sites:admin: phone:read:list_sites:admin
phone:write:site:admin: phone:write:site:admin
phone:read:site:admin: phone:read:site:admin
phone:delete:site:admin: phone:delete:site:admin
phone:update:site:admin: phone:update:site:admin
phone:read:list_site_customized_number:admin: phone:read:list_site_customized_number:admin
phone:delete:site_customized_number:admin: phone:delete:site_customized_number:admin
phone:write:site_customized_number:admin: phone:write:site_customized_number:admin
phone:read:site_setting:admin: phone:read:site_setting:admin
phone:write:site_setting:admin: phone:write:site_setting:admin
phone:delete:site_setting:admin: phone:delete:site_setting:admin
phone:update:site_setting:admin: phone:update:site_setting:admin
phone:read:list_users:admin: phone:read:list_users:admin
phone:write:batch_users:admin: phone:write:batch_users:admin
phone:update:batch_users:admin: phone:update:batch_users:admin
phone:read:user: phone:read:user
phone:read:user:admin: phone:read:user:admin
phone:update:user: phone:update:user
phone:update:user:admin: phone:update:user:admin
phone:delete:user_call_handling_setting: phone:delete:user_call_handling_setting
phone:delete:user_call_handling_setting:admin: phone:delete:user_call_handling_setting:admin
phone:write:user_call_handling_setting: phone:write:user_call_handling_setting
phone:write:user_call_handling_setting:admin: phone:write:user_call_handling_setting:admin
phone:read:user_call_handling_setting:admin: phone:read:user_call_handling_setting:admin
phone:read:user_call_handling_setting: phone:read:user_call_handling_setting
phone:update:user_call_handling_setting:admin: phone:update:user_call_handling_setting:admin
phone:update:user_call_handling_setting: phone:update:user_call_handling_setting
phone:write:calling_plan: phone:write:calling_plan
phone:write:calling_plan:admin: phone:write:calling_plan:admin
phone:update:calling_plan: phone:update:calling_plan
phone:update:calling_plan:admin: phone:update:calling_plan:admin
phone:delete:users_calling_plan: phone:delete:users_calling_plan
phone:delete:users_calling_plan:admin: phone:delete:users_calling_plan:admin
phone:read:list_user_customized_number: phone:read:list_user_customized_number
phone:read:list_user_customized_number:admin: phone:read:list_user_customized_number:admin
phone:write:user_customized_number: phone:write:user_customized_number
phone:write:user_customized_number:admin: phone:write:user_customized_number:admin
phone:delete:user_customized_number: phone:delete:user_customized_number
phone:delete:user_customized_number:admin: phone:delete:user_customized_number:admin
phone:update:user_policy:admin: phone:update:user_policy:admin
phone:read:user_policy:admin: phone:read:user_policy:admin
phone:delete:user_setting: phone:delete:user_setting
phone:delete:user_setting:admin: phone:delete:user_setting:admin
phone:write:user_setting:admin: phone:write:user_setting:admin
phone:write:user_setting: phone:write:user_setting
phone:read:user_setting:admin: phone:read:user_setting:admin
phone:read:user_setting: phone:read:user_setting
phone:update:user_setting: phone:update:user_setting
phone:update:user_setting:admin: phone:update:user_setting:admin
phone:update:shared_setting: phone:update:shared_setting
phone:update:shared_setting:admin: phone:update:shared_setting:admin
phone:write:shared_setting: phone:write:shared_setting
phone:write:shared_setting:admin: phone:write:shared_setting:admin
phone:delete:shared_setting: phone:delete:shared_setting
phone:delete:shared_setting:admin: phone:delete:shared_setting:admin
phone_voicemail:read: phone_voicemail:read
phone_voicemail:read:admin: phone_voicemail:read:admin
phone:read:voicemail: phone:read:voicemail
phone:read:voicemail:admin: phone:read:voicemail:admin
phone:read:list_voicemails: phone:read:list_voicemails
phone:read:list_voicemails:admin: phone:read:list_voicemails:admin
phone_voicemail:write: phone_voicemail:write
phone_voicemail:write:admin: phone_voicemail:write:admin
phone:update:voicemail: phone:update:voicemail
phone:update:voicemail:admin: phone:update:voicemail:admin
phone:delete:voicemail: phone:delete:voicemail
phone:delete:voicemail:admin: phone:delete:voicemail:admin
phone:read:list_rooms:admin: phone:read:list_rooms:admin
phone:write:room:admin: phone:write:room:admin
phone:read:room:admin: phone:read:room:admin
phone:delete:room:admin: phone:delete:room:admin
phone:update:room:admin: phone:update:room:admin
phone:write:room_calling_plan:admin: phone:write:room_calling_plan:admin
phone:delete:room_calling_plan:admin: phone:delete:room_calling_plan:admin
phone:write:room_phone_number:admin: phone:write:room_phone_number:admin
phone:delete:room_phone_number:admin: phone:delete:room_phone_number:admin
externalDocs:
description: Find out more about Swagger
url: https://swagger.io