openapi: 3.2.0 info: title: Phone Roles 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: Phone Roles paths: /phone/roles: get: tags: - Phone Roles summary: List phone roles description: "Returns the phone roles.\n\n**Prerequisites:**\n* Business or Education account\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_roles:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: ListPhoneRoles responses: '200': description: '**HTTP Status Code:** `200` **OK** Successfully listed phone roles.' content: application/json: schema: type: object properties: roles: maxItems: 250 type: array description: The phone role list. items: type: object properties: id: type: string description: The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. example: MRNStlOVS02fJ6pOAzrh0A name: type: string description: The user's [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name. example: Phone Super Admin description: type: string description: The role description. example: Admin has full privileges to access and manage the Zoom Phone (default). total_members: type: integer description: The total members assigned to the role. example: 1 is_default: type: boolean description: Whether the role is default or not. example: true '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `401`
\n Invalid access token.
\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_roles:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_roles:admin post: tags: - Phone Roles summary: Duplicate a phone role description: "Use this API to duplicate a phone role.\n\n**Prerequisites:**\n* Business or Education account\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:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: DuplicatePhoneRole requestBody: content: application/json: schema: required: - role_id type: object properties: role_id: type: string description: Unique identifier of the source [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. example: MRNStlOVS02fJ6pOAzrh0B name: type: string description: User's [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name. example: Phone Super Admin description: type: string description: Role description. example: Admin has full privileges to access and manage the Zoom Phone (default). responses: '201': description: '**HTTP Status Code:** `201` **Created** Successfully duplicated a phone role.' content: application/json: schema: type: object properties: id: type: string description: Unique identifier of the newly duplicated [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. example: MRNStlOVS02fJ6pOAzrh0A name: type: string description: User's [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name. example: Compliance Admin (Copy) '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\n\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:write:role:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:role:admin /phone/roles/{roleId}: get: tags: - Phone Roles summary: Get role information description: "Use this API to get information on a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business, or Education account\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:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`" operationId: getRoleInformation parameters: - name: roleId in: path description: The role ID. required: true schema: type: string example: cw2r21Vh21 responses: '200': description: "**Status Code:** `200` \n \nInformation about a specific role returned." content: application/json: schema: type: object properties: description: type: string description: Description of the role. example: Admin has full privileges to access and manage the Zoom Phone (default). id: type: string description: The role ID. example: MRNStlOVS02fJ6pOAzrh0A name: type: string description: Name of the role. example: Phone Super Admin total_members: type: integer description: Total members assigned to that role. example: 1 is_default: type: boolean description: Indicates whether it is a default role. example: true '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:role:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:role:admin delete: tags: - Phone Roles summary: Delete a phone role description: "Use this API to delete a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business, or Education account\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:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: DeletePhoneRole parameters: - name: roleId in: path description: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A responses: '204': description: '**HTTP Status Code:** `204` **No Content** Successfully deleted a phone role.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\n\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:role:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:role:admin patch: tags: - Phone Roles summary: Update a phone role description: "Use this API to update a role.\n\n**Prerequisites:**\n* Business, or Education account\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:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: UpdatePhoneRole parameters: - name: roleId in: path description: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A requestBody: content: application/json: schema: type: object properties: name: type: string description: User's [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name. Name length can be up to 128 characters example: Phone Super Admin description: type: string description: Role description. Description length can be up to 255 characters example: Admin has full privileges to access and manage the Zoom Phone (default). responses: '204': description: '**HTTP Status Code:** `204` **No Content** Successfully updated a role.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\n\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:role:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:role:admin /phone/roles/{roleId}/members: get: tags: - Phone Roles summary: List members in a role description: "Use this API to get members (not) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\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:role_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`" operationId: ListRoleMembers parameters: - name: roleId in: path description: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A - name: in_role in: query description: 'Whether the user belongs to the role: default is `false`.' required: false schema: type: boolean example: false default: false responses: '200': description: '**HTTP Status Code:** `200` **OK** Successfully listed members (not) in the role.' content: application/json: schema: type: object properties: members: type: array description: Member list. items: type: object properties: user_id: type: string description: The user ID. example: 1PXbl7s6Q52nbePrUxUZTg display_name: type: string description: Display name. example: ZOOM_API Test email: type: string description: Email. example: 2020042400000003@qq.com extension_number: type: integer description: Extension number. format: int64 example: 1000123460 site: type: object properties: id: type: string description: Unique identifier of the site. example: 8f71O6rWT8KFUGQmJIFAdQ name: type: string description: Site name. example: Main Site description: Site. '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\n\n\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found\n\n**Error Code:** `2001`
\nAccount 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:read:admin - phone:read:role_member:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:role_member:admin post: tags: - Phone Roles summary: Add members to roles description: "Use this API to add members to [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management#h_01EFHY1R4QWAYTA6Z661NM9Q27).\n\n**Prerequisites:**\n* Business or Education account\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:role_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: AddRoleMembers parameters: - name: roleId in: path description: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A requestBody: content: application/json: schema: type: object properties: role_id: type: string description: 'Unique identifier of the existing [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user: used when copying members'' role.' example: Ft0H7NYlSX6EeO-rwaZW-Q copy_targets: type: boolean description: 'Whether to copy the target: used when copying members'' role.' example: true default: false copy_all_members: type: boolean description: 'Whether to copy all members with the role: used when copying members'' role.' example: true default: false user_ids: type: array description: The user IDs or email addresses of the user items: type: string example: 1PXbl7s6Q52nbePrUxUZTg responses: '201': description: '**HTTP Status Code:** `201` **No Content** Successfully added members to a role.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `300`
\n\n\n**Error Code:** `400`
\nThere are invalid emails:{0}\n\nThere are invalid user ids:{0}\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:write:role_member:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:role_member:admin delete: tags: - Phone Roles summary: Delete members in a role description: "Use this API to delete member(s) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\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:role_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`" operationId: DelRoleMembers parameters: - name: roleId in: path description: Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A - name: user_ids in: query description: The user IDs or email addresses of the user required: true schema: type: array items: type: string example: tw9GZQNlQVW9vGq8sm0n_Q responses: '204': description: '**HTTP Status Code:** `204` **No Content** Successfully deleted members in a role.' '400': description: "**HTTP Status Code:** `400`
\n Bad Request\n\n**Error Code:** `400`
\nThere are invalid emails:{0}\n\nThere are invalid user ids:{0}\n\n**Error Code:** `300`
\n\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:role_member:admin openapi_authorization: [] x-extensions: x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:role_member:admin /phone/roles/{roleId}/targets: get: tags: - Phone Roles summary: List phone role targets description: "Targets of a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). \n\n**Prerequisites:** \n* Business or Education account \n* 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:list_roles:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: ListPhoneRoleTargets parameters: - name: roleId in: path description: The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A - name: is_default in: query description: 'If`is_default`=`true`, it manages the role default targets. If `is_default`=`false`, it manages the role member targets.' required: false schema: type: boolean example: false default: false - name: user_id in: query description: The role member ID. It's required if `is_default`=`false`. required: false schema: type: string example: 1PXbl7s6Q52nbePrUxUZTg - name: selected in: query description: "`selected`=`true`filters the targets that are in the role.\n `selected`=`false` filters the targets that are not in the role." required: false schema: type: boolean example: true default: true - name: target_type in: query description: "The target type. \n\nDifferent types of roles manage different types of targets: \n\n * super_admin: need not manage targets. \n\n * site_admin: support site type. \n\n * callQueue_admin: support callQueue type. \n\n * autoReceptionist_admin: support autoReceptionist type. \n\n * sharedLineGroup_admin: support sharedLineGroup type. \n\n * commonArea_admin: support site type. \n\n * recording_admin: support site, callQueue, autoReceptionist, user, group types. \n\n * compliance_admin: support site, callQueue, user, group, sharedLineGroup, commonArea types." required: false schema: type: string example: user enum: - site - callQueue - autoReceptionist - user - group - sharedLineGroup - commonArea - name: site_id in: query description: The unique identifier of the site. required: false schema: type: string example: 8f71O6rWT8KFUGQmJIFAdQ - name: keyword in: query description: The keyword of the name or extension ID. It provides the ability to search by keyword. required: false schema: type: string example: abcxyz - name: page_size in: query description: The number of records returned from a single API call. required: false schema: type: string example: '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. This token's expiration period is 15 minutes. required: false schema: type: string example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2 responses: '200': description: '**HTTP Status Code:** `200` **OK** Successfully listed the role targets.' 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 is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: nav48KOj42vYPSG4f0cCdT575bZ980did22 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 records found for this query. example: 45 targets: type: array description: The list of role member targets. items: type: object properties: target_id: type: string description: The target ID. example: zSBIkYJzS6KkQqu5nFxvgg target_type: type: string description: "The target type. \n\nDifferent types of roles manage different types of targets: \n\n * super_admin: need not manage targets. \n\n * site_admin: support site type. \n\n * callQueue_admin: support callQueue type. \n\n * autoReceptionist_admin: support autoReceptionist type. \n\n * sharedLineGroup_admin: support sharedLineGroup type. \n\n * commonArea_admin: support site type. \n\n * recording_admin: support site, callQueue, autoReceptionist, user, group types. \n\n * compliance_admin: support site, callQueue, user, group, sharedLineGroup, commonArea types." example: user enum: - site - callQueue - autoReceptionist - user - group - sharedLineGroup - commonArea target_name: type: string description: The target name. example: Test name extension_number: type: integer description: The extension number of the target. example: 1234503 site_id: type: string description: The unique identifier of the site. example: 8f71O6rWT8KFUGQmJIFAdQ site_name: type: string description: The site name. example: Main Site description: The details about the target. '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed { \"field\": \"target_type\", \"message\": \"Invalid field.\" }
\n**Error Code:** `400`
\n The next page token is invalid or expired.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Phone role does not exist for role Id: {roleId}.
\n**Error Code:** `1001`
\n User does not exist for user id: {user_id}.
\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_roles:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_roles:admin post: tags: - Phone Roles summary: Add phone role targets description: "Adds targets to phone [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* 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:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: AddPhoneRoleTargets parameters: - name: roleId in: path description: The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A requestBody: content: application/json: schema: required: - targets type: object properties: is_default: type: boolean description: "If `is_default`=`true`, then it manages the role default targets. \nIf `is_default`=`false`, then it manages the role member targets." example: false default: false user_id: type: string description: The role member ID. It's required if `is_default`=`false`. example: 1PXbl7s6Q52nbePrUxUZTg targets: maxItems: 500 type: array description: The targets you want to add. items: required: - target_ids type: object properties: target_type: type: string description: "The target type. \n\nDifferent types of roles manage different types of targets: \n\n * super_admin: need not manage targets. \n\n * site_admin: support site type. \n\n * callQueue_admin: support callQueue type. \n\n * autoReceptionist_admin: support autoReceptionist type. \n\n * sharedLineGroup_admin: support sharedLineGroup type. \n\n * commonArea_admin: support site type. \n\n * recording_admin: support site, callQueue, autoReceptionist, user, group types. \n\n * compliance_admin: support site, callQueue, user, group, sharedLineGroup, commonArea types." example: user enum: - site - callQueue - autoReceptionist - user - group - sharedLineGroup - commonArea target_ids: maxItems: 10 minItems: 1 type: array description: The list of target IDs. items: type: string description: The target ID. example: GP2lPCb_Tm2j9uJwmgsMBQ responses: '201': description: "**HTTP Status Code:** `201` **OK** \nSuccessfully added the role targets." content: application/json: schema: type: object properties: is_default: type: boolean description: '`is_default`=`true`, manage the role default targets; `is_default`=`false`, manage the role member targets.' example: false default: false user_id: type: string description: The member ID. Required if `is_default`=`false`. example: 1PXbl7s6Q52nbePrUxUZTg targets: maxItems: 500 type: array description: The targets you want to add. items: type: object properties: target_type: type: string description: "The target type. Different types of roles manage different types of targets. \n\n * super_admin: need not manage targets. \n\n * site_admin: support site type. \n\n * callQueue_admin: support callQueue type. \n\n * autoReceptionist_admin: support autoReceptionist type. \n\n * sharedLineGroup_admin: support sharedLineGroup type. \n\n * commonArea_admin: support site type. \n\n * recording_admin: support site, callQueue, autoReceptionist, user, group types. \n\n * compliance_admin: support site, callQueue, user, group, sharedLineGroup, commonArea types." example: user enum: - site - callQueue - autoReceptionist - user - group - sharedLineGroup - commonArea target_ids: maxItems: 10 type: array description: If the target type is site, then the target ID refers to the site ID; otherwise, it refers to the extension ID. items: type: string description: The target id. example: GP2lPCb_Tm2j9uJwmgsMBQ '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed. The `targets[?].target_ids` size must be between 1 and 10.
\n**Error Code:** `400`
\n There are invalid target IDs: {target_ids}.
\n**Error Code:** `405`
\n The number of items for targets must not exceed 500.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Phone role does not exist for role id: {roleId}.
\n**Error Code:** `1001`
\n User does not exist for user id: {user_id}.
\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:role:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:role:admin delete: tags: - Phone Roles summary: Delete phone role targets description: "Deletes the targets of a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* 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:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: DeletePhoneRoleTargets parameters: - name: roleId in: path description: The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user. required: true schema: type: string example: MRNStlOVS02fJ6pOAzrh0A requestBody: content: application/json: schema: required: - targets type: object properties: is_default: type: boolean description: 'If`is_default`=`true`, then it manages the role default targets. If `is_default`=`false`, then it manages the role member targets.' example: false default: false user_id: type: string description: The role member ID. It's required if `is_default`=`false`. example: 1PXbl7s6Q52nbePrUxUZTg targets: maxItems: 500 type: array description: The targets you want to delete. items: required: - target_ids type: object properties: target_type: type: string description: "The target type. \n\nDifferent types of roles manage different types of targets:\n\n * super_admin: need not manage targets. \n\n * site_admin: support site type. \n\n * callQueue_admin: support callQueue type. \n\n * autoReceptionist_admin: support autoReceptionist type. \n\n * sharedLineGroup_admin: support sharedLineGroup type. \n\n * commonArea_admin: support site type. \n\n * recording_admin: support site, callQueue, autoReceptionist, user, group types. \n\n * compliance_admin: support site, callQueue, user, group, sharedLineGroup, commonArea types." example: user enum: - site - callQueue - autoReceptionist - user - group - sharedLineGroup - commonArea target_ids: maxItems: 10 minItems: 1 type: array description: The list of target ID. items: type: string description: The target ID. example: GP2lPCb_Tm2j9uJwmgsMBQ responses: '204': description: "**HTTP Status Code:** `201` **OK** \nSuccessfully deleted the role targets." '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation failed.
\n`targets[?].target_ids` size must be between 1 and 10.
\n**Error Code:** `400`
\n The user ID cannot be empty.
\n**Error Code:** `405`
\n The number of items for targets must not exceed 500.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Phone role does not exist for role Id: {roleId}.
\n**Error Code:** `1001`
\n User does not exist for user id: {user_id}.
\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:role:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:role: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