openapi: 3.2.0
info:
title: Phone Zoom Rooms 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: Zoom Rooms
paths:
/phone/rooms:
get:
tags:
- Zoom Rooms
summary: List Zoom Rooms under Zoom Phone license
description: 'Retrieves a list of [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) under the account that has the Zoom Phone license assigned.**Prerequisites:** * A Pro or higher account plan * 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:list_rooms:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`'
operationId: listZoomRooms
parameters:
- 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: 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 site ID retrievable from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.
required: false
schema:
type: string
example: kLD4F3WBT-O9LYE31C0tRQ
- name: calling_type
in: query
description: The type of calling plan.
required: false
schema:
type: integer
example: 100
- name: keyword
in: query
description: The Zoom room name or phone number from which to filter the results .
required: false
schema:
type: string
example: test_zoom_room
responses:
'200':
description: "**HTTP Status Code:** `200` **OK** \n \nZoom Rooms retrieved successfully."
content:
application/json:
schema:
type: object
properties:
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: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
page_size:
maximum: 300
type: integer
description: The number of records returned from a single API call.
example: 30
default: 30
rooms:
maxItems: 300
type: array
items:
type: object
properties:
calling_plans:
maxItems: 100
type: array
items:
type: object
properties:
name:
type: string
description: Name of the calling plan that Zoom Room is enrolled in.
example: AU/NZ Metered
type:
type: integer
description: The type of calling plan of which the Zoom Room is enrolled.
example: 100
billing_account_id:
type: string
description: The billing account ID. it's displayed when the zoom room is located in India.
example: 3WWAEiEjTj2IQuyDiKMd_A
billing_account_name:
type: string
description: The billing account name. It's displayed when the Zoom Room is located in India.
example: Delhi billing
billing_subscription_id:
type: string
description: The billing subscription ID. It displays when the account supports billing multiple subscriptions
example: FT-SUBREF-21168178
billing_subscription_name:
type: string
description: The billing subscription name. It displays when the account supports billing multiple subscriptions.Can be edited via the Billing page
example: My Subscription
extension_id:
type: string
description: The extension ID.
example: _zQiBLNDQumOuA_tOnBIrw
extension_number:
type: integer
description: The extension number assigned to the Zoom Room's Zoom phone number.
format: int64
example: 10010
id:
type: string
description: The unique Identifier of the Zoom Room.
example: 3JTPXDqTQCuzYJEwH6kN4g
name:
type: string
description: The name of the Zoom Room.
example: test
phone_numbers:
maxItems: 5
type: array
items:
type: object
properties:
id:
type: string
description: The ID for phone number.
example: CMOXjhb7RHeVeiH0zL0f9A
number:
type: string
description: The phone number in E164 format.
example: '12058945544'
site:
type: object
properties:
id:
type: string
description: The [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) ID.
example: kLD4F3WBT-O9LYE31C0tRQ
name:
type: string
description: The name of the site.
example: API DZ SITE3
total_records:
type: integer
description: The total records found for this query.
example: 1
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `403`
\n You do not have permission.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\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_rooms:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_rooms:admin
post:
tags:
- Zoom Rooms
summary: Add a Zoom Room to a Zoom Phone
description: "Associates a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a Zoom Phone license. \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:write:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: addZoomRoom
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The Zoom Room ID.
example: _zQiBLNDQumOuA_tOnBIrw
site_id:
type: string
description: The ID of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
example: kLD4F3WBT-O9LYE31C0tRQ
calling_plans:
maxItems: 100
type: array
items:
type: object
properties:
type:
type: integer
description: The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of calling plan.
example: 100
billing_subscription_id:
type: string
description: The billing subscription ID. When there is more than one plan type A in this account, it cannot be empty.
example: FT-SUBREF-21168178
responses:
'201':
description: "**HTTP Status code:** `201` \n \nZoom Room added successfully."
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Unknown or invalid calling plan: {type}.
\n**Error Code:** `404`
\n Room does not exist:{roomId}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\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:room:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:room:admin
/phone/rooms/unassigned:
get:
tags:
- Zoom Rooms
summary: List Zoom Rooms without Zoom Phone assignment
description: 'Returns [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) that are not assigned a Zoom Phone.**Prerequisites:** * A Pro or higher account plan * 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:list_rooms:admin`
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`'
operationId: listUnassignedZoomRooms
parameters:
- name: keyword
in: query
description: A search keyword for Zoom Room's name.
required: false
schema:
type: string
example: room_1
responses:
'200':
description: "**HTTP Status Code:** `200` **OK** \n \nAvailable Zoom Rooms retrieved successfully."
content:
application/json:
schema:
type: object
properties:
rooms:
maxItems: 100
type: array
items:
type: object
properties:
id:
type: string
description: The Zoom Room ID.
example: _zQiBLNDQumOuA_tOnBIrw
display_name:
type: string
description: Name of the Zoom Room.
example: room_1
location_id:
type: string
description: The Zoom Room location ID.
example: 3zEOmHchRaWCb7hx9XwROg
location_info:
type: string
description: The Zoom Room location information.
example: San Jose City,California State,Unite States Country/Region
department:
type: string
description: The department the Zoom Room belongs to.
example: pbx department
cost_center:
type: string
description: The cost center the Zoom Room belongs to.
example: pbx cost center
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\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_rooms:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:list_rooms:admin
/phone/rooms/{roomId}:
get:
tags:
- Zoom Rooms
summary: Get a Zoom Room under Zoom Phone license
description: "Specifies [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account with an assigned Zoom Phone license.\n\n**Prerequisites** \n* A Pro or higher account plan \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:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getZoomRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
responses:
'200':
description: "**HTTP Status Code:** `200` **OK** \n \nZoom Room retrieved successfully."
content:
application/json:
schema:
type: object
properties:
calling_plans:
type: array
items:
type: object
properties:
name:
type: string
description: Name of the calling plan that Zoom Room is enrolled in.
example: AU/NZ Metered
type:
type: integer
description: Type of calling plan that Zoom Room is enrolled in.
example: 100
billing_account_id:
type: string
description: Billing account ID. Displayed when the zoom room is located in India.
example: 3WWAEiEjTj2IQuyDiKMd_A
billing_account_name:
type: string
description: Billing account name. Displayed when the zoom room is located in India.
example: Delhi billing
billing_subscription_id:
type: string
description: The billing subscription ID. It displays when the account supports billing multiple subscriptions
example: FT-SUBREF-21168178
billing_subscription_name:
type: string
description: The billing subscription name. It displays when the account supports billing multiple subscriptions.Can be edited via the Billing page
example: My Subscription
emergency_address:
type: object
properties:
address_line1:
type: string
description: The emergency location address line 1.
example: '122'
address_line2:
type: string
description: The emergency location address line 2.
example: '122'
city:
type: string
description: The emergency location address's city.
example: '12'
country:
type: string
description: Two-lettered country code (Aplha-2 code in ISO-3166 format).
example: SG
id:
type: string
description: The emergency location address ID.
example: fXEdhQmSQheGaNuLYbm8Wg
state_code:
type: string
description: The emergency location address's state code.
example: '123'
zip:
type: string
description: The emergency address zip code.
example: '50383'
description: The emergency location's address information.
extension_id:
type: string
description: Extension ID.
example: _zQiBLNDQumOuA_tOnBIrw
extension_number:
type: integer
description: 'The extension number of the Zoom Room. '
format: int64
example: 1233012
id:
type: string
description: Unique Identifier of the Zoom Room.
example: 3JTPXDqTQCuzYJEwH6kN4g
name:
type: string
description: Name of the Zoom Room.
example: test
phone_numbers:
type: array
items:
type: object
properties:
id:
type: string
description: ID for phone number.
example: 6fTPXDwT2CuzYrwwH6sN4g
number:
type: string
description: Phone number in E164 format.
example: '12058945544'
policy:
type: object
properties:
international_calling:
type: object
properties:
enable:
type: boolean
description: Allow current extension to place international calls outside of the calling plan.
example: false
locked_by:
type: string
description: Which level of administrator prohibits modifying the current settings.
example: site
enum:
- invalid
- account
- user_group
- site
- extension
select_outbound_caller_id:
type: object
properties:
enable:
type: boolean
description: Allow current extension to change outbound caller ID when placing calls.
example: false
locked_by:
type: string
description: Which level of administrator prohibits modifying the current settings.
example: account
enum:
- invalid
- account
- user_group
- site
- extension
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).
example: kLD4F3WBT-O9LYE31C0tRQ
name:
type: string
description: Name of the site.
example: API DZ SITE3
'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:room:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
x-granular-scopes:
- phone:read:room:admin
delete:
tags:
- Zoom Rooms
summary: Remove a Zoom Room from a ZP account
description: "Use this API to remove [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037) from a Zoom Phone account.\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:delete:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
operationId: RemoveZoomRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
responses:
'204':
description: "**HTTP Status Code:** `204` \n \nZoom Room removed successfully."
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `404`
\nRoom does not exist:{roomId}.\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:room:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:room:admin
patch:
tags:
- Zoom Rooms
summary: Update a Zoom Room under Zoom Phone license
description: "Use this API to update a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account that has the Zoom Phone license assigned.\n\n**Prerequisites:** \n* A Pro or higher account plan \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:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
operationId: updateZoomRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
requestBody:
content:
application/json:
schema:
type: object
properties:
extension_number:
type: integer
description: The extension number of the Zoom Room. The number must be complete (i.e. site number + short extension).
format: int64
example: 123487
policy:
type: object
properties:
international_calling:
type: object
properties:
enable:
type: boolean
description: Allow current extension to place international calls outside of the calling plan.
example: true
reset:
type: boolean
description: Using site setting.
example: true
select_outbound_caller_id:
type: object
properties:
enable:
type: boolean
description: Allow current extension to change outbound caller ID when placing calls.
example: true
reset:
type: boolean
description: Using site setting.
example: true
site_id:
type: string
description: Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
example: kLD4F3WBT-O9LYE31C0tRQ
responses:
'204':
description: "**HTTP Status Code:** `204` **No Content** \n \nZoom Room updated successfully."
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nExtension number error.\n\n**Error Code:** `400`
\nPolicy locked: {policy_key}.\n\n**Error Code:** `404`
\nRoom does not exist:{roomId}\nSite does not exist.\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:update:room:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:room:admin
/phone/rooms/{roomId}/calling_plans:
post:
tags:
- Zoom Rooms
summary: Assign calling plans to a Zoom Room
description: "Assigns [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a maximum of 200 numbers at a time.\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:write:room_calling_plan:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: assignCallingPlanToRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
requestBody:
content:
application/json:
schema:
type: object
properties:
calling_plans:
maxItems: 5
type: array
items:
type: object
properties:
type:
type: integer
description: '[Type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan.'
example: 100
billing_account_id:
type: string
description: Billing account ID. If the zoom room is located in India, the field is required.
example: 3WWAEiEjTj2IQuyDiKMd_A
billing_subscription_id:
type: string
description: The billing subscription ID. When there is more than one plan type A in this account, it cannot be empty.
example: FT-SUBREF-21168178
responses:
'201':
description: "**HTTP Status code:** `201` \n \nCalling plan assigned successfully."
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Plan invalid.
\n**Error Code:** `404`
\n Room does not exist:{roomId}.
\n**Error Code:** `429`
\n Room batch operation is limited to 5 per request.
\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:room_calling_plan:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:room_calling_plan:admin
/phone/rooms/{roomId}/calling_plans/{type}:
delete:
tags:
- Zoom Rooms
summary: Remove a calling plan from a Zoom Room
description: "Use this API to unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037).\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:delete:room_calling_plan:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
operationId: unassignCallingPlanFromRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
- name: type
in: path
description: 'The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to the Zoom Room. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)
'
required: true
schema:
type: integer
example: 100
- name: billing_account_id
in: query
description: The billing account ID. If the zoom room is located in India, the parameter is required.
required: false
schema:
type: string
example: 3WWAEiEjTj2IQuyDiKMd_A
responses:
'204':
description: "**HTTP Status Code:** `204` \n \nCalling plan removed successfully."
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\nPlan invalid.\n\n**Error Code:** `404`
\nRoom does not exist:{roomId}.\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:room_calling_plan:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:room_calling_plan:admin
/phone/rooms/{roomId}/phone_numbers:
post:
tags:
- Zoom Rooms
summary: Assign phone numbers to a Zoom Room
description: "[Assigns phone numbers to a Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711). Up to 200 numbers at a time.\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:write:room_phone_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: assignPhoneNumberToZoomRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
requestBody:
description: Provide either the ID or phone number in the request body.
content:
application/json:
schema:
type: object
properties:
phone_numbers:
maxItems: 5
type: array
items:
type: object
properties:
id:
type: string
description: ID for phone number
example: '---M1padRvSUtw7YihN7sA'
number:
type: string
description: Phone number in E164 format.
example: '12058945616'
responses:
'201':
description: "**HTTP Status Code:** `201` \n \nPhone number assigned successfully."
content:
application/json:
schema:
type: object
properties: {}
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `404`
\n Room does not exist:{roomId}.\nPhone number does not exist.
\n**Error Code:** `409`
\n Phone number already in use.\nThis function requires a Zoom Phone Metered, Unlimited, or Pro plan.
\n**Error Code:** `429`
\n Room batch operation is limited to 5 per request.
\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:room_phone_number:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:write:room_phone_number:admin
/phone/rooms/{roomId}/phone_numbers/{phoneNumberId}:
delete:
tags:
- Zoom Rooms
summary: Remove a phone number from a Zoom Room
description: "Use this API to unassign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The Zoom Room must have been previously assigned a Zoom Phone number\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:room_phone_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
operationId: UnassignPhoneNumberFromZoomRoom
parameters:
- name: roomId
in: path
description: Provide roomId of the Zoom Room.
required: true
schema:
type: string
example: 3JTPXDqTQCuzYJEwH6kN4g
- name: phoneNumberId
in: path
description: 'Provide phoneNumberId of the Zoom Room. '
required: true
schema:
type: string
example: ecj-KtsRRV-LcUPxAh99zQ
responses:
'204':
description: '**HTTP Status Code:** `204`
The phone number has been removed successfully.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `404`
\nRoom does not exist:{roomId}.\nPhone number does not exist.\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:room_phone_number:admin
openapi_authorization: []
x-extensions:
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:delete:room_phone_number: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