openapi: 3.2.0 info: title: Phone Outbound Calling 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: Outbound Calling paths: /phone/common_areas/{commonAreaId}/outbound_calling/countries_regions: get: tags: - Outbound Calling summary: Get common area level outbound calling countries and regions description: "Returns the common area level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: GetCommonAreaOutboundCallingCountriesAndRegions parameters: - name: commonAreaId in: path description: The ID of the common area. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: next_page_token in: query description: The next page token paginates through a large set of results. It 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` Outbound calling country regions returned. ' content: application/json: schema: type: object properties: countries_regions: type: array items: type: object properties: name: type: string description: The country name. example: United States code: type: integer description: The country code. example: 1 iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` Allowed\n`2` Blocked \n`3` Requires local number, caller ID, or plan\n`4` Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 enabled_carrier: type: array description: The enabled carrier, which could be "ZOOM" or "BYOC". items: type: string example: ZOOM next_page_token: type: string description: The next page token paginates through large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records from a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The common area does not exist: {commonAreaId}.
\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:common_area_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:common_area_outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update common area level outbound calling countries or regions description: 'Updates the common area level outbound calling policy country or region. **Prerequisite:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateCommonAreaOutboundCallingCountriesOrRegions parameters: - name: commonAreaId in: path description: The ID of the common area. required: true schema: type: string example: SJD6tIJpQHeTU4RDde-NVA requestBody: content: application/json: schema: type: object properties: country_regions: type: array items: type: object properties: iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` - Allowed\n`2` - Blocked\n`3` - Requires local number, caller ID, or plan\n`4` - Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 delete_existing_exception_rules: type: boolean description: Whether to delete existing exception rules. This field only appears when the default outbound calling rule is changed. The default value is `false`. example: false responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The common area does not exist: {commonAreaId}.
\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:common_area_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:common_area_outbound_calling_rule:admin /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules: get: tags: - Outbound Calling summary: List common area level outbound calling exception rules description: 'Lists the common area level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with 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:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: listCommonAreaOutboundCallingExceptionRule parameters: - name: commonAreaId in: path description: The ID of the common area. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: country in: query description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). required: false schema: type: string example: US - name: keyword in: query description: The partial string of a phone number. required: false schema: type: string example: '11067' - name: match_type in: query description: The match type of an exception rule. required: false schema: type: string example: prefix enum: - phoneNumber - prefix - name: status in: query description: The status of an exception rule. required: false schema: type: string example: active enum: - active - inactive - 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` **OK** List outbound calling exception rules successfully.' content: application/json: schema: type: object properties: exception_rules: type: array items: type: object properties: id: type: string description: The exception rule ID. example: 2ypsHHwTTFK-fzZJkudYwA match_type: type: string description: 'The match type for the exception rule: `phoneNumber`and `prefix`.' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without country code. example: '20665558945' rule: type: integer description: The exception rule type `1` - allowed, `2` - blocked, `3` - require local number, caller ID or plan, `4` - require to enter the extension number and PIN code. example: 1 enum: - 1 - 2 - 3 - 4 comment: maxLength: 255 type: string description: A comment to help identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive 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: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records in a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The common area does not exist: {commonAreaId}.
\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:common_area_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:common_area_outbound_calling_rule:admin post: tags: - Outbound Calling summary: Add common area level outbound calling exception rule description: 'Adds the common area level outbound calling policy exception rule for the country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: AddCommonAreaOutboundCallingExceptionRule parameters: - name: commonAreaId in: path description: The ID of the common area. required: true schema: type: string example: SJD6tIJpQHeTU4RDde-NVA requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: "The match type for the exception rule:\n\n`phoneNumber`\n `prefix`" example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule for the phone number prefix or the phone number without the country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment that identifies the exception rule number or the prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n\n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nCreated successfully." content: application/json: schema: type: object properties: exception_rule_id: type: string description: The IDs of the exception rules. example: jE1rtyf0Tx6N86L4pBYV4Q '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The common area does not exist: {commonAreaId}.
\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:common_area_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:common_area_outbound_calling_rule:admin /phone/common_areas/{commonAreaId}/outbound_calling/exception_rules/{exceptionRuleId}: delete: tags: - Outbound Calling summary: Delete common area level outbound calling exception rule description: 'Deletes the common area level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: deleteCommonAreaOutboundCallingExceptionRule parameters: - name: commonAreaId in: path description: The ID of the common area. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n" '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n**Error Code:** `13508`
\n The exception rule ID has one more record in the DB: {exceptionRuleId}.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The common area does not exist: {commonAreaId}.
\n**Error Code:** `13507`
\n The exception rule does not exist: {exceptionRuleId}.
\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:common_area_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:common_area_outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update common area level outbound calling exception rule description: 'Updates the common area level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateCommonAreaOutboundCallingExceptionRule parameters: - name: commonAreaId in: path description: The ID of the common area. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: 'The match type for the exception rule. The values are `phoneNumber` or `prefix`. ' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without the country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment to identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The common area does not exist: {commonAreaId}.
\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:common_area_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:common_area_outbound_calling_rule:admin /phone/outbound_calling/countries_regions: get: tags: - Outbound Calling summary: Get account level outbound calling countries and regions description: "Returns the account level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_outbound_calling_rules:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: GetAccountOutboundCallingCountriesAndRegions parameters: - name: next_page_token in: query description: The next page token paginates through a large set of results. It 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` Outbound calling country regions returned. ' content: application/json: schema: type: object properties: countries_regions: type: array items: type: object properties: name: type: string description: The country name. example: United States code: type: integer description: The country code. example: 1 iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` Allowed\n`2` Blocked \n`3` Requires local number, caller ID, or plan\n`4` Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 enabled_carrier: type: array description: The enabled carrier, which could be "ZOOM" or "BYOC". items: type: string example: ZOOM next_page_token: type: string description: The next page token paginates through 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: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records in a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\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_outbound_calling_rules:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_outbound_calling_rules:admin patch: tags: - Outbound Calling summary: Update account level outbound calling countries or regions description: 'Updates the account level outbound calling policy country or region. **Prerequisite:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateAccountOutboundCallingCountriesOrRegions requestBody: content: application/json: schema: type: object properties: country_regions: type: array items: type: object properties: iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` - Allowed\n`2` - Blocked\n`3` - Requires local number, caller ID, or plan\n`4` - Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 delete_existing_exception_rules: type: boolean description: Whether to delete existing exception rules. This field only appears when the default outbound calling rule is changed. The default value is `false`. example: false responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\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:outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:outbound_calling_rule:admin /phone/outbound_calling/exception_rules: get: tags: - Outbound Calling summary: List account level outbound calling exception rules description: 'Lists the account level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with 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_outbound_calling_rules:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: listAccountOutboundCallingExceptionRule parameters: - name: country in: query description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). required: false schema: type: string example: US - name: keyword in: query description: The partial string of a phone number. required: false schema: type: string example: '11067' - name: match_type in: query description: The match type of an exception rule. required: false schema: type: string example: prefix enum: - phoneNumber - prefix - name: status in: query description: The status of an exception rule. required: false schema: type: string example: active enum: - active - inactive - name: next_page_token in: query description: The next page token paginates through a large set of results. It 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` **OK** List outbound calling exception rules successfully.' content: application/json: schema: type: object properties: exception_rules: type: array items: type: object properties: id: type: string description: The exception rule ID. example: 2ypsHHwTTFK-fzZJkudYwA match_type: type: string description: The match type for the exception rule. The values are `phoneNumber`or `prefix`. example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without the country code. example: '20665558945' rule: type: integer description: "The exception rule type.\n`1` - Allowed \n`2` - Blocked \n`3` - Requires local number, caller ID, or plan \n`4` - Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 comment: maxLength: 255 type: string description: A comment to identify the exception rule number or the prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive next_page_token: type: string description: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records in a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\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_outbound_calling_rules:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:list_outbound_calling_rules:admin post: tags: - Outbound Calling summary: Add account level outbound calling exception rule description: 'Adds the account level outbound calling policy exception rule for country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: AddAccountOutboundCallingExceptionRule requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: "The match type for the exception rule:\n\n`phoneNumber`\n `prefix`" example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or phone number without the country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment that identifies the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nCreated successfully." content: application/json: schema: type: object properties: exception_rule_id: type: string description: The IDs of the exception rules. example: jE1rtyf0Tx6N86L4pBYV4Q '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\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:outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:outbound_calling_rule:admin /phone/outbound_calling/exception_rules/{exceptionRuleId}: delete: tags: - Outbound Calling summary: Delete account level outbound calling exception rule description: 'Deletes the account level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: deleteAccountOutboundCallingExceptionRule parameters: - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n" '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n**Error Code:** `13508`
\n The exception rule ID has one more record in the DB: {exceptionRuleId}.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13507`
\n The exception rule does not exist: {exceptionRuleId}.
\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:outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update account level outbound calling exception rule description: 'Updates the account level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateAccountOutboundCallingExceptionRule parameters: - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: 'The match type for the exception rule, The values are `phoneNumber` or `prefix`. ' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment to identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\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:outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:outbound_calling_rule:admin /phone/sites/{siteId}/outbound_calling/countries_regions: get: tags: - Outbound Calling summary: Get site level outbound calling countries and regions description: "Returns the site level outbound calling countries and regions.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:site_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`" operationId: GetSiteOutboundCallingCountriesAndRegions parameters: - name: siteId in: path description: The ID of the site. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: next_page_token in: query description: The next page token paginates through a large set of results. It 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` Outbound calling country regions returned. ' content: application/json: schema: type: object properties: countries_regions: type: array items: type: object properties: name: type: string description: The country name. example: United States code: type: integer description: The country code. example: 1 iso_code: type: string description: The country ISO code. example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` Allowed\n`2` Blocked \n`3` Requires local number, caller ID, or plan\n`4` Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 enabled_carrier: type: array description: The enabled carrier, which could be "ZOOM" or "BYOC". items: type: string example: ZOOM next_page_token: type: string description: The next page token paginates through large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records in a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The site does not exist: {siteId}.
\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:site_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:site_outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update site level outbound calling countries or regions description: 'Updates the site level outbound calling policy country or region. **Prerequisites:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateSiteOutboundCallingCountriesOrRegions parameters: - name: siteId in: path description: The ID of the site. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg requestBody: content: application/json: schema: type: object properties: country_regions: type: array items: type: object properties: iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` - Allowed\n`2` - Blocked\n`3` - Requires local number, caller ID, or plan\n`4` - Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 delete_existing_exception_rules: type: boolean description: Whether to delete existing exception rules. This field only appears when the default outbound calling rule is changed. The default value is `false`. example: false responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The site does not exist: {siteId}.
\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:site_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:site_outbound_calling_rule:admin /phone/sites/{siteId}/outbound_calling/exception_rules: get: tags: - Outbound Calling summary: List site level outbound calling exception rules description: 'Returns a list of site level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with 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:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: listSiteOutboundCallingExceptionRule parameters: - name: siteId in: path description: The ID of the site. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: country in: query description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). required: false schema: type: string example: US - name: keyword in: query description: The partial string of a phone number. required: false schema: type: string example: '11067' - name: match_type in: query description: The match type of an exception rule. required: false schema: type: string example: prefix enum: - phoneNumber - prefix - name: status in: query description: The status of an exception rule. required: false schema: type: string example: active enum: - active - inactive - 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` **OK** List outbound calling exception rules successfully.' content: application/json: schema: type: object properties: exception_rules: type: array items: type: object properties: id: type: string description: The exception rule ID. example: 2ypsHHwTTFK-fzZJkudYwA match_type: type: string description: 'The match type for the exception rule: `phoneNumber`and `prefix`.' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or phone number without country code. example: '20665558945' rule: type: integer description: The exception rule type `1` - allowed, `2` - blocked, `3` - require local number, caller ID or plan, `4` - require to enter the extension number and PIN code. example: 1 enum: - 1 - 2 - 3 - 4 comment: maxLength: 255 type: string description: A comment to help you identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive 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: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records in single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The site does not exist: {siteId}.
\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:site_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:site_outbound_calling_rule:admin post: tags: - Outbound Calling summary: Add site level outbound calling exception rule description: 'Adds the site level outbound calling policy exception rule for the country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: AddSiteOutboundCallingExceptionRule parameters: - name: siteId in: path description: The ID of the site. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: "The match type for the exception rule.\n`phoneNumber`\n `prefix`" example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment that identifies the exception rule number or the prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nCreated successfully." content: application/json: schema: type: object properties: exception_rule_id: type: string description: The IDs of the exception rules. example: jE1rtyf0Tx6N86L4pBYV4Q '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The site does not exist: {siteId}.
\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:site_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:site_outbound_calling_rule:admin /phone/sites/{siteId}/outbound_calling/exception_rules/{exceptionRuleId}: delete: tags: - Outbound Calling summary: Delete site level outbound calling exception rule description: 'Deletes the site level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: deleteSiteOutboundCallingExceptionRule parameters: - name: siteId in: path description: The ID of the site. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n" '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n**Error Code:** `13508`
\n The exception rule ID has one more record in the DB: {exceptionRuleId}.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The site does not exist: {siteId}.
\n**Error Code:** `13507`
\n The exception rule does not exist: {exceptionRuleId}.
\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:site_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:site_outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update site level outbound calling exception rule description: 'Updates the site level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateSiteOutboundCallingExceptionRule parameters: - name: siteId in: path description: The ID of the site. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: 'The match type for the exception rule. The values are `phoneNumber` or `prefix`. ' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without the country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment to identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The site does not exist: {siteId}.
\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:site_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:site_outbound_calling_rule:admin /phone/users/{userId}/outbound_calling/countries_regions: get: tags: - Outbound Calling summary: Get user level outbound calling countries and regions description: 'Returns the user level outbound calling countries and regions. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: GetUserOutboundCallingCountriesAndRegions parameters: - name: userId in: path description: The ID of the user. required: true schema: type: string example: SJD6tIJpQHeTU4RDde-NVA - 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: "**HTTP Status Code:** `200` \n Outbound calling country regions returned. " content: application/json: schema: type: object properties: countries_regions: maxItems: 100 type: array items: type: object properties: name: type: string description: The country name. example: United States code: type: integer description: The country code. example: 1 iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` Allowed\n`2` Blocked \n`3` Requires local number, caller ID, or plan\n`4` Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 enabled_carrier: maxItems: 10 type: array description: The enabled carrier, which could be "ZOOM" or "BYOC". items: type: string example: ZOOM next_page_token: type: string description: The next page token paginates through large set of results. The 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: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records in a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The user does not exist: {userId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read:user_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:user_outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update user level outbound calling countries or regions description: 'Updates the user level outbound calling policy country or region. **Prerequisite:** * Account must have a Pro or a higher plan with a Zoom Phone license. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateUserOutboundCallingCountriesOrRegions parameters: - name: userId in: path description: The ID of the user. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg requestBody: content: application/json: schema: type: object properties: country_regions: maxItems: 300 type: array items: type: object properties: iso_code: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US rule: type: integer description: "The default outbound calling rule. \n\n`1` - Allowed\n`2` - Blocked\n`3` - Requires local number, caller ID, or plan\n`4` - Requires the extension number and PIN code" example: 1 enum: - 1 - 2 - 3 - 4 delete_existing_exception_rules: type: boolean description: Whether to delete existing exception rules. This field only appears when the default outbound calling rule is changed. The default value is `false`. example: false responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The user does not exist: {userId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:update:user_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:user_outbound_calling_rule:admin /phone/users/{userId}/outbound_calling/exception_rules: get: tags: - Outbound Calling summary: List user level outbound calling exception rules description: 'Returns a list of the user level outbound calling policy exception rules. **Prerequisite:** * Pro or higher account plan with 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:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: listUserOutboundCallingExceptionRule parameters: - name: userId in: path description: The ID of the user. required: true schema: type: string example: SJD6tIJpQHeTU4RDde-NVA - name: country in: query description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). required: false schema: type: string example: US - name: keyword in: query description: The partial string of a phone number. required: false schema: type: string example: '11067' - name: match_type in: query description: The match type of an exception rule. required: false schema: type: string example: prefix enum: - phoneNumber - prefix - name: status in: query description: The status of an exception rule. required: false schema: type: string example: active enum: - active - inactive - 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: page_size in: query description: The number of records in a single API call. required: false schema: maximum: 300 type: integer example: 30 default: 30 responses: '200': description: '**HTTP Status Code:** `200` **OK** List outbound calling exception rules successfully.' content: application/json: schema: type: object properties: exception_rules: maxItems: 100 type: array items: type: object properties: id: type: string description: The exception rule ID. example: 2ypsHHwTTFK-fzZJkudYwA match_type: type: string description: 'The match type for the exception rule: `phoneNumber`and `prefix`.' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or phone number without country code. example: '20665558945' rule: type: integer description: The exception rule type `1` - allowed, `2` - blocked, `3` - require local number, caller ID or plan, `4` - require to enter the extension number and PIN code. example: 1 enum: - 1 - 2 - 3 - 4 comment: maxLength: 255 type: string description: A comment to identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive 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: uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2 page_size: maximum: 300 type: integer description: The total number of records returned from a single API call. example: 30 default: 30 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13000`
\n The user does not exist: {userId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read:user_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin x-granular-scopes: - phone:read:user_outbound_calling_rule:admin post: tags: - Outbound Calling summary: Add user level outbound calling exception rule description: 'Adds an user level outbound calling policy exception rule for the country region. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: AddUserOutboundCallingExceptionRule parameters: - name: userId in: path description: The ID of the user required: true schema: type: string example: SJD6tIJpQHeTU4RDde-NVA requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: "The match type for the exception rule.\n`phoneNumber`\n `prefix`" example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment that identifies the exception rule number or the prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '201': description: "**HTTP Status Code:** `201` **Created** \n \n\nCreated successfully." content: application/json: schema: type: object properties: exception_rule_id: type: string description: The IDs of the exception rules. example: jE1rtyf0Tx6N86L4pBYV4Q '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The user does not exist: {userId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:write:user_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:write:user_outbound_calling_rule:admin /phone/users/{userId}/outbound_calling/exception_rules/{exceptionRuleId}: delete: tags: - Outbound Calling summary: Delete user level outbound calling exception rule description: 'Deletes the user level outbound calling exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license * Account owner or admin permissions **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: deleteUserOutboundCallingExceptionRule parameters: - name: userId in: path description: The ID of the user. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA responses: '204': description: "**HTTP Status Code:** `204` **No Content** \n \n" '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n**Error Code:** `13508`
\n The exception rule ID has one more record in the DB: {exceptionRuleId}.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The user does not exist: {userId}.
\n**Error Code:** `13507`
\n The exception rule does not exist: {exceptionRuleId}.
\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:user_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:delete:user_outbound_calling_rule:admin patch: tags: - Outbound Calling summary: Update user level outbound calling exception rule description: 'Updates the user level outbound calling policy for the country region exception rule. **Prerequisites:** * Pro or a higher account with Zoom Phone license. * Account owner or admin permissions. **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_outbound_calling_rule:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`' operationId: UpdateUserOutboundCallingExceptionRule parameters: - name: userId in: path description: The ID of the user. required: true schema: type: string example: TAjiGweoTLeK72SaeocBZg - name: exceptionRuleId in: path description: The exception rule ID. required: true schema: type: string example: 2ypsHHwTTFK-fzZJkudYwA requestBody: content: application/json: schema: type: object properties: exception_rule: required: - country - match_type - prefix_number - status type: object properties: match_type: type: string description: 'The match type for the exception rule, The values are `phoneNumber` or `prefix`. ' example: prefix enum: - phoneNumber - prefix prefix_number: maxLength: 50 type: string description: The exception rule phone number prefix or the phone number without country code. example: '20665558945' comment: maxLength: 255 type: string description: A comment to identify the exception rule number or prefix. example: test status: type: string description: "Whether the exception rule is active or inactive. \n`active`: The exception rule is active.\n`inactive`: The exception rule is inactive." example: active enum: - active - inactive country: type: string description: The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). example: US responses: '204': description: "**HTTP Status Code:** `204` \n \nNo Content \n " '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `13504`
\n You do not enable the outbound calling policy setting.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Requires an access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `13500`
\n The user does not exist: {userId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:update:user_outbound_calling_rule:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin x-granular-scopes: - phone:update:user_outbound_calling_rule: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