{
"opencollection": "1.0.0",
"info": {
"name": "Phone",
"version": "2"
},
"items": [
{
"info": {
"name": "Accounts",
"type": "folder"
},
"items": [
{
"info": {
"name": "List an account's Zoom Phone settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/account_settings",
"params": [
{
"name": "setting_types",
"value": "",
"type": "query",
"description": "The comma separated list of the setting items you want to fetch. Allowed values: `call_live_transcription`,`local_survivability_mode`,`external_calling_on_zoom_room_common_area`, `select_outbound_caller_id`, `personal_audio_library`, `voicemail`, `voicemail_transcription`, `voicemail_notification_by_email`, `shared_voicemail_notification_by_email`, `restricted_call_hours`, `allowed_call_locations`, `check_voicemails_over_phone`, `auto_call_recording`, `ad_hoc_call_recording`, `international_calling`, `outbound_calling`, `outbound_sms`, `sms`, `sms_etiquette_tool`, `zoom_phone_on_mobile`, `zoom_phone_on_pwa`, `e2e_encryption`, `call_handling_forwarding_to_other_users`, `call_overflow`, `call_transferring`, `elevate_to_meeting`, `call_park`, `hand_off_to_room`, `mobile_switch_to_carrier`, `delegation`, `audio_intercom`, `block_calls_without_caller_id`, `block_external_calls`,`call_queue_opt_out_reason`,`auto_delete_data_after_retention_duration`,`auto_call_from_third_party_apps`, `override_default_port`,`peer_to_peer_media`,`advanced_encryption`,`display_call_feedback_survey`,`block_list_for_inbound_calls_and_messaging`,`block_calls_as_threat`,`manage_call_routing_for_unassigned_numbers`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's Zoom Phone settings.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_account_settings:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "List an account's customized outbound caller ID phone numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/outbound_caller_id/customized_numbers",
"params": [
{
"name": "selected",
"value": "",
"type": "query",
"description": "The status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "This field filters phone numbers that belong to the site."
},
{
"name": "extension_type",
"value": "",
"type": "query",
"description": "The type of extension to which the phone number belongs."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "A search keyword for phone or extension numbers."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves phone numbers that can be used as the `account-level` customized outbound caller ID. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes"
},
{
"info": {
"name": "Add phone numbers for an account's customized outbound caller ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/outbound_caller_id/customized_numbers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the `account-level` customized outbound caller ID phone numbers. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:wri"
},
{
"info": {
"name": "Delete phone numbers for an account's customized outbound caller ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/outbound_caller_id/customized_numbers",
"params": [
{
"name": "customize_ids",
"value": "",
"type": "query",
"description": "The customization IDs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the `account-level` customized outbound caller ID phone numbers. Note that when multiple sites policy is enabled, users cannot manage the `account-level` configuration. The system will throw an exception.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:"
}
]
},
{
"info": {
"name": "Alerts",
"type": "folder"
},
"items": [
{
"info": {
"name": "List alert settings with paging query",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/alert_settings",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records a single API call returns."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of the returned records."
},
{
"name": "module",
"value": "",
"type": "query",
"description": "This field filters the specific alert list by the module. The module and its code mappings are shown as: \n \n`Call Queue Management`-`1`, `Route Group Management`-`2`, `Devices & Phones Management`-`3`, `Call Quality Management`-`4`, `Emergency Services Management`-`5`"
},
{
"name": "rule",
"value": "",
"type": "query",
"description": "This field filters the specific alert list by the rule. The rule and its code mappings display as: \n \n`Service Level`-`1`, `Inbound Abandoned Calls`-`2`, `Inbound Overflowed Calls`-`3`, `Inbound Avg Call Waiting Time`-`4`, `Inbound Forwarded to Voicemail`-`5`, `Number of Waiting Calls`-`6`, `Member Availability (Active)`-`7`, `Member Availability (Opt-in/Opt-out)`-`8`, `Route groups status change`-`9`, `Devices go offline`-`10`, `Devices go online`-`11`, `Device offline rate`-`12`, `QoS Alert`-`13`, `Emergency Call Alert`-`14`. \n \nWhen the value of the `module` is `1`, the value of `rule` can only be in the range of `1` to `8`. \n \nWhen the value of the `module` is `2`, the value of `rule` can only be `9`. \n \nWhen the value of the `module` is `3`, the value of `rule` can only be in the range of `10` to `12`. \n \nWhen the value of the `module` is `4`, the value of `rule` can only be `13`. \n \nWhen the value of the `module` is `5`, the value of `rule` can only be `14`."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The alert's status:\n* `0` — Inactive.\n* `1` — Active."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets [alert settings](https://support.zoom.us/hc/en-us/articles/7146944434445) for an account with paging query.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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_alert_settings:admin`\n\n**[Rate Limit Label](https://marketplace.zoom"
},
{
"info": {
"name": "Add an alert setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/alert_settings",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Adds an alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:alert_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-li"
},
{
"info": {
"name": "Get alert setting details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/alert_settings/:alertSettingId",
"params": [
{
"name": "alertSettingId",
"value": "",
"type": "path",
"description": "The unique Identifier of the alert setting."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns detailed information about a specific [alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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:alert_setting:admin`\n\n**[Rate Limit Label](https://marketplace."
},
{
"info": {
"name": "Update an alert setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/alert_settings/:alertSettingId",
"params": [
{
"name": "alertSettingId",
"value": "",
"type": "path",
"description": "The alert setting ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates information of an [Alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:patch:alert_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api"
},
{
"info": {
"name": "Delete an alert setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/alert_settings/:alertSettingId",
"params": [
{
"name": "alertSettingId",
"value": "",
"type": "path",
"description": "The alert setting ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes an [alert setting](https://support.zoom.us/hc/en-us/articles/7146944434445).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:alert_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-l"
}
]
},
{
"info": {
"name": "Audio Library",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get an audio item",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/audios/:audioId",
"params": [
{
"name": "audioId",
"value": "",
"type": "path",
"description": "The unique identifier of the audio item."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an audio item. Only the admin or user can access your audio.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:audio`,`phone:read:audio:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGH"
},
{
"info": {
"name": "Update an audio item",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/audios/:audioId",
"params": [
{
"name": "audioId",
"value": "",
"type": "path",
"description": "Unique identifier of the audio item."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates an audio item. Only the admin or user can update your audio.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:audio`,`phone:update:audio:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):**"
},
{
"info": {
"name": "Delete an audio item",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/audios/:audioId",
"params": [
{
"name": "audioId",
"value": "",
"type": "path",
"description": "Unique identifier of the audio item."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes an audio item. Only the admin or user can delete your audio.\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:audio`,`phone:delete:audio:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):*"
},
{
"info": {
"name": "List audio items",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/audios",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns personal audios. \n\nOnly the admin or user can query your audios and directly pass the `me` value instead of the `userId` parameter.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_audios`,`phone:read:list_audios:admin`\n\n**[Rate Limit Labe"
},
{
"info": {
"name": "Add an audio item for text-to-speech conversion",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/audios",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an audio item for [text-to-speech conversion](https://support.zoom.us/hc/en-us/articles/4402414203533-Using-the-audio-library-to-customize-audio#h_01F8B0D2ZJBKEDH10DFZ7J2CM7). Only the admin or user can add your audio and directly pass the `me` value instead of the `userId` parameter.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Sc"
},
{
"info": {
"name": "Add audio items",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/audios/batch",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the audio items. You can only upload voice files at this time. Only the admin or user can add your audio and directly pass the `me` value instead of the `userId` parameter.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n**Size and quantity limits for audio attachments:**\n* Up to 5 attachments\n* Each file size should be no more than 1MB\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granula"
}
]
},
{
"info": {
"name": "Auto Receptionists",
"type": "folder"
},
"items": [
{
"info": {
"name": "List auto receptionists",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/auto_receptionists",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The total number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of auto receptionists.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_auto_receptionists:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
{
"info": {
"name": "Add an auto receptionist",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/auto_receptionists",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) to a Zoom Phone. Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area, voicemail or an IVR system. \n\n**Prerequisites:**\n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overvie"
},
{
"info": {
"name": "Get an auto receptionist",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information on a specific auto receptionist.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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:auto_receptionist:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Update an auto receptionist",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Changes information](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3) such as the display name and the extension number assigned to the main auto receptionist.\n\nAn auto receptionist answers calls with a personalized recording. And it routes calls to a phone user, call queue, common area, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voic"
},
{
"info": {
"name": "Delete a non-primary auto receptionist",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Deletes a non-primary auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-#h_1d5ffc56-6ba3-4ce5-9d86-4a1a1ee743f3).\n\nAn auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area (phone), or to a voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routi"
},
{
"info": {
"name": "Get auto receptionist call handling setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/call_handling/settings",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
},
{
"name": "hour_type",
"value": "",
"type": "query",
"description": "The hour type of the call handling setting."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `hour_type` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `hour_type` is `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call handling setting of an auto receptionist for the specified hour type.\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:auto_receptionist_call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#"
},
{
"info": {
"name": "Update auto receptionist call handling setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/call_handling/settings/:hourType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. The `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the call handling setting of an auto receptionist for the specified hour type.\n\n**Prerequisites:**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limi"
},
{
"info": {
"name": "Assign phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/phone_numbers",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns available phone numbers to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). The available numbers can be retrieved using the List Phone Numbers API with `type` query parameter set to "unassigned".\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overv"
},
{
"info": {
"name": "Unassign all phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/phone_numbers",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns all phone numbers that were previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-sco"
},
{
"info": {
"name": "Unassign a phone number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "Unique Identifier of the phone number or provide the actual phone number in e164 format (example: +19995550123)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns a specific phone number that was previously assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oaut"
},
{
"info": {
"name": "Get an auto receptionist policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/policies",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the policy setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:a"
},
{
"info": {
"name": "Update an auto receptionist policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/policies",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the policy setting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:u"
},
{
"info": {
"name": "Add a policy subsetting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/policies/:policyType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists API](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listAutoReceptionists)."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "Corresponds to the policy item you wish to add. Allowed values: `voice_mail`"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a policy subsetting for a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the `policyType`. For example, you can use this API to set up shared access members.
**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n*"
},
{
"info": {
"name": "Update a policy subsetting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/policies/:policyType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists ](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listAutoReceptionists) API."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field corresponds to the policy item you wish to modify. \n\nAllowed values: `voice_mail`"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the policy subsetting of a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the `policyType`. For example, you can use this API to update shared access members.\n\n**Prerequisites**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**"
},
{
"info": {
"name": "Delete a policy subsetting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/policies/:policyType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. It can be retrieved from the [List auto receptionists](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listAutoReceptionists) API."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field corresponds to the policy item you wish to remove. \n\nAllowed values: `voice_mail`"
},
{
"name": "shared_ids",
"value": "",
"type": "query",
"description": "The unique identifier of the voicemail that the user can access. It's required only for `voice_mail` policy type."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the policy subsetting for a specific [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Interactive-Voice-Response-IVR-) according to the `policyType`. For example, you can use this API to remove shared access members.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**"
},
{
"info": {
"name": "Get auto receptionist settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/settings",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
},
{
"name": "setting_type",
"value": "",
"type": "query",
"description": "The setting item to query. Defaults to `business_hours` if not provided. Allowed values: `holiday_hours`, `business_hours`, `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns auto receptionist settings.\n\n**Prerequisites:**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:auto_receptionist_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add auto receptionist setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/settings/:settingType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item you want to add. Allowed values: `holiday_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the auto receptionist setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:auto_receptionist_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limit"
},
{
"info": {
"name": "Update auto receptionist setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/settings/:settingType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item you want to modify. Allowed values: `holiday_hours`, `business_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the auto receptionist setting according to the setting type.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-lim"
},
{
"info": {
"name": "Delete auto receptionist setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/settings/:settingType",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type to delete. Allowed values: `holiday_hours`, `break_hours`."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `settingType` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `settingType` is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete the auto receptionist setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:auto_receptionist_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-li"
}
]
},
{
"info": {
"name": "Billing Account",
"type": "folder"
},
"items": [
{
"info": {
"name": "List billing accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/billing_accounts",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. This field is required only if the [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) option has been enabled for the account."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves a list of available billing accounts for a Zoom account owner or a user with admin privileges. \n\nIf the [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) option has been enabled for the account, then `field(site_id)` is required.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://develo"
},
{
"info": {
"name": "Get billing account details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/billing_accounts/:billingAccountId",
"params": [
{
"name": "billingAccountId",
"value": "",
"type": "path",
"description": "The billing account ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A Zoom account owner or a user with admin privilege can use this API to get information about a billing account.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:billing_account:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#"
}
]
},
{
"info": {
"name": "Blocked List",
"type": "folder"
},
"items": [
{
"info": {
"name": "List blocked lists",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/blocked_list",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The total number of records returned from a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns all the blocked lists in an acccount. A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available. \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[Scopes](htt"
},
{
"info": {
"name": "Create a blocked list",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/blocked_list",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a block list and add a number to the list. \n\nA Zoom account owner or a user with the admin privilege can block phone numbers for phone users in an account. \n\nBlocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). \n\nBlocked callers will hear a generic message stating that the person they are calling is not available. \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n"
},
{
"info": {
"name": "Get blocked list details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/blocked_list/:blockedListId",
"params": [
{
"name": "blockedListId",
"value": "",
"type": "path",
"description": "The unique identifier of the blocked list."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the information about a specific blocked list. \n\nA Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[S"
},
{
"info": {
"name": "Update a blocked list",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/blocked_list/:blockedListId",
"params": [
{
"name": "blockedListId",
"value": "",
"type": "path",
"description": "Unique Identifier of the Blocked List."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the information in the blocked list.\n\nA Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers hear a generic message stating that the person they are calling is not available.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[Scopes](https://d"
},
{
"info": {
"name": "Delete a blocked list",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/blocked_list/:blockedListId",
"params": [
{
"name": "blockedListId",
"value": "",
"type": "path",
"description": "The unique identifier of the blocked list."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a blocked list, which removes the associated number from the blocked list. \n\nThe number will be unblocked after the deletion. A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers).\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[Scopes](https://developers."
}
]
},
{
"info": {
"name": "Call Handling",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get call handling settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/call_handling/settings",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information about a Zoom Phone call handling settings.\n\nCall handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, auto receptionist, or shared line g"
},
{
"info": {
"name": "Add a call handling setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/call_handling/settings/:settingType",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The call handling setting type: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds Zoom Phone call handling subsettings for your phone system. Call handling settings allow you to control how your system routes calls during business, closed, or holiday hours. For more information, see our [API guide](https://developers.zoom.us/docs/api/phone/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, auto receptionist, or shared line group call "
},
{
"info": {
"name": "Update a call handling setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/call_handling/settings/:settingType",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The call handling setting type: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a Zoom Phone call handling setting.\n\nCall handling settings allow you to control how your system routes calls during business, closed, or holiday hours. For more information, read our [Call Handling API guide](https://developers.zoom.us/docs/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, auto receptionist, or shared line g"
},
{
"info": {
"name": "Delete a call handling setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/call_handling/settings/:settingType",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The type of call handling setting: \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`"
},
{
"name": "call_forwarding_id",
"value": "",
"type": "query",
"description": "The call forwarding's ID. Use this parameter if you pass the `call_forwarding_id` value for the `settingType` parameter."
},
{
"name": "holiday_id",
"value": "",
"type": "query",
"description": "The holiday's ID. Use this parameter if you pass the `holiday_id` value for the `settingType` parameter."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a Zoom Phone's call handling settings. Call handling settings let you control how your system routes calls during business, closed, or holiday hours. For more information, read our [API guide](https://marketplace.zoom.us/docs/guides/zoom-phone/call-handling/) or Zoom support article [Customizing call handling settings](https://support.zoom.us/hc/en-us/articles/360059966372-Customizing-call-handling-settings).\n\n**Applicable to user, call queue, auto receptionist, or shared line group call"
}
]
},
{
"info": {
"name": "Call Logs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get call element",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_element/:callElementId",
"params": [
{
"name": "callElementId",
"value": "",
"type": "path",
"description": "The ID of the call element."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call element for a given call element ID.\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_call_log:read`,`phone_call_log:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):*"
},
{
"info": {
"name": "Get account's call history",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_history",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword of the name, extension, number, email address, and call ID. It provides the ability to search by keyword and it shows a list of all the related calls. Any calls go through this keyword."
},
{
"name": "directions",
"value": "",
"type": "query",
"description": "The direction filter of the call logs."
},
{
"name": "connect_types",
"value": "",
"type": "query",
"description": "The connect type filter of the call logs. \n* `internal` \n* `external` "
},
{
"name": "number_types",
"value": "",
"type": "query",
"description": "The number type filter of the caller or callee. "
},
{
"name": "call_types",
"value": "",
"type": "query",
"description": "The call type filter of the call logs. \n* `general` \n* `emergency`"
},
{
"name": "extension_types",
"value": "",
"type": "query",
"description": "The extension type filter of the call logs."
},
{
"name": "call_results",
"value": "",
"type": "query",
"description": "The call result filter of the call logs."
},
{
"name": "group_ids",
"value": "",
"type": "query",
"description": "The primary group filter of call logs."
},
{
"name": "site_ids",
"value": "",
"type": "query",
"description": "The site filter of call logs."
},
{
"name": "department",
"value": "",
"type": "query",
"description": "The department where the call log belongs."
},
{
"name": "cost_center",
"value": "",
"type": "query",
"description": "The cost center where the call log belongs."
},
{
"name": "time_type",
"value": "",
"type": "query",
"description": "This field enables you to search call logs by start or end time. By default, using start_time"
},
{
"name": "recording_status",
"value": "",
"type": "query",
"description": "The recording filter indicates whether the whole call has recording or not. Recorded means the call has at least one recording. `non_recorded` means the call does not have any recordings."
},
{
"name": "with_voicemail",
"value": "",
"type": "query",
"description": "The voicemail filter of the call logs."
},
{
"name": "call_ids",
"value": "",
"type": "query",
"description": "The call ID to filter the call logs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's new edition of [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license \n* Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://"
},
{
"info": {
"name": "Get call history",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_history/:callHistoryUuid",
"params": [
{
"name": "callHistoryUuid",
"value": "",
"type": "path",
"description": "The ID of the call history."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).\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`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zo"
},
{
"info": {
"name": "Add a client code to a call history",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_history/:callLogId/client_code",
"params": [
{
"name": "callLogId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. \n\n**Prerequisites**\n* Business or Education account\n* Zoom Phone license \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_log:admin`\n\n**[Rate Limit Label](htt"
},
{
"info": {
"name": "Get call history detail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_history_detail/:callHistoryId",
"params": [
{
"name": "callHistoryId",
"value": "",
"type": "path",
"description": "The ID of call history."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": " Returns the call history details for a given call log ID [call history](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). \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_call_log:read`,`phone_call_log:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_"
},
{
"info": {
"name": "Get account's call logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_logs",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The type of the call logs. The value can be either "all" or "missed"."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "path",
"value": "",
"type": "query",
"description": "This field filters the API response by [path](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs#h_646b46c6-0623-4ab1-8b8b-ea5b8bcef679) of the call. The value of this field can be one of the following: `voiceMail`, `message`, `forward`, `extension`, `callQueue`, `ivrMenu`, `companyDirectory`, `autoReceptionist`, `contactCenter`, `disconnected`, `commonAreaPhone`,\n`pstn`, `transfer`, `sharedLines`, `sharedLineGroup`, `tollFreeBilling`, `meetingService`, `parkPickup`,\n`parkTimeout`, `monitor`, `takeover`, `sipGroup`"
},
{
"name": "time_type",
"value": "",
"type": "query",
"description": "This field enables you to search call logs by start or end time. You can choose `startTime` or `endTime`."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site."
},
{
"name": "charged_call_logs",
"value": "",
"type": "query",
"description": "Whether to filter API responses to include call logs that only have a non-zero charge."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://developers.z"
},
{
"info": {
"name": "Get call log details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_logs/:callLogId",
"params": [
{
"name": "callLogId",
"value": "",
"type": "path",
"description": "The unique identifier of the call log. Both `callLogId` and `callId` can be used as path parameters. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or the [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).\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`,`phone_call_log:read:admin`,`phone:read`,`phone_call_log:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate"
},
{
"info": {
"name": "Add a client code to a call log",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.zoom.us/v2/phone/call_logs/:callLogId/client_code",
"params": [
{
"name": "callLogId",
"value": "",
"type": "path",
"description": "The unique identifier of the call log."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. \n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_log:admin`\n\n**[Rate Limit Label"
},
{
"info": {
"name": "Get User AI Call Summary Detail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/user/:userId/ai_call_summary/:aiCallSummaryId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The owner's user ID."
},
{
"name": "aiCallSummaryId",
"value": "",
"type": "path",
"description": "The ID of the AI call summary."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns AI call summary details. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:ai_call_summar"
},
{
"info": {
"name": "Get user's call history",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_history",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword of the name, extension, number, email address, and call ID. It provides the ability to search by keyword and it shows a list of all the related calls. Any calls go through this keyword."
},
{
"name": "directions",
"value": "",
"type": "query",
"description": "The direction filter of the call logs."
},
{
"name": "connect_types",
"value": "",
"type": "query",
"description": "The connect type filter of the call logs. \n* `internal` \n* `external` "
},
{
"name": "number_types",
"value": "",
"type": "query",
"description": "The number type filter of the caller or callee. "
},
{
"name": "call_types",
"value": "",
"type": "query",
"description": "The call type filter of the call logs. \n* `general` \n* `emergency`"
},
{
"name": "extension_types",
"value": "",
"type": "query",
"description": "The extension type filter of the call logs."
},
{
"name": "call_results",
"value": "",
"type": "query",
"description": "The call result filter of the call logs."
},
{
"name": "group_ids",
"value": "",
"type": "query",
"description": "The primary group filter of call logs."
},
{
"name": "site_ids",
"value": "",
"type": "query",
"description": "The site filter of call logs."
},
{
"name": "department",
"value": "",
"type": "query",
"description": "The department of which the call log belongs."
},
{
"name": "cost_center",
"value": "",
"type": "query",
"description": "The cost center of which the call log belongs."
},
{
"name": "time_type",
"value": "",
"type": "query",
"description": "This field enables you to search call logs by start or end time. By default, using start_time"
},
{
"name": "recording_status",
"value": "",
"type": "query",
"description": "The recording filter indicates whether the whole call has recording or not. recorded means the call has at least one recording, non_recorded means the call does not have any recordings."
},
{
"name": "with_voicemail",
"value": "",
"type": "query",
"description": "The voicemail filter of the call logs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call history. \r\n\r\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\r\n\r\n**Prerequisites** \r\n* A Business or Enterprise account \r\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call"
},
{
"info": {
"name": "Sync user's call history",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_history/sync",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
},
{
"name": "sync_type",
"value": "",
"type": "query",
"description": "The options for synchronizing call log: FSync - Full sync ISync - Increase sync BSync - Backward sync"
},
{
"name": "count",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "sync_token",
"value": "",
"type": "query",
"description": "The time range for returned records. It's used for locating where the next retrieval will begin."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call history. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read`\n\n**[Gr"
},
{
"info": {
"name": "Delete a user's call history",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_history/:callLogId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user."
},
{
"name": "callLogId",
"value": "",
"type": "path",
"description": "The unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a user's [call history](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n\n* Belong to a Business or Enterprise account \n* Have a Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`,`phone_call_log"
},
{
"info": {
"name": "Get user's call logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_logs",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "This field filters API responses to include call logs of only the phone number defined in this field."
},
{
"name": "time_type",
"value": "",
"type": "query",
"description": "This field enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read:admin`,`phone_c"
},
{
"info": {
"name": "Sync user's call logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_logs/sync",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID."
},
{
"name": "sync_type",
"value": "",
"type": "query",
"description": "The options for synchronizing call log: \n \nFSync - Full sync \n \nISync - Increase sync \n \nBSync - Backward sync"
},
{
"name": "count",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "sync_token",
"value": "",
"type": "query",
"description": "The time range for returned records. It's used for locating where the next retrieval will begin."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read`\n\n**[Granul"
},
{
"info": {
"name": "Delete a user's call log",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_logs/:callLogId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user."
},
{
"name": "callLogId",
"value": "",
"type": "path",
"description": "The unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a user's [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`,`"
}
]
},
{
"info": {
"name": "Call Queues",
"type": "folder"
},
"items": [
{
"info": {
"name": "List call queue analytics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queue_analytics",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The call start time in GMT **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The earliest data available for query is from 2 years ago. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "The call end time in GMT **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. Queries must be within a one-year interval. If unspecified, it would be present day"
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the call queue is assigned."
},
{
"name": "call_queue_ext_ids",
"value": "",
"type": "query",
"description": "The call queue extension ID list."
},
{
"name": "department",
"value": "",
"type": "query",
"description": "The department of which the call queue belongs."
},
{
"name": "cost_center",
"value": "",
"type": "query",
"description": "The cost center where the call queue belongs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call queue analytics overview.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queues:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "List call queues",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned from a single API call."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API."
},
{
"name": "cost_center",
"value": "",
"type": "query",
"description": "The call queue's cost center."
},
{
"name": "department",
"value": "",
"type": "query",
"description": "The call queue's department."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to list Call queues.\n\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes"
},
{
"info": {
"name": "Create a call queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Creates a call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413). Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on.\n You can add phone users or common areas to call queues.\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owne"
},
{
"info": {
"name": "Get call queue details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue. You can retrieve it from the [List Call Queues API](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-call-queues/listcallqueues)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Routes incoming calls to a group of users and returns information on a specific call queue. \n\nFor instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on. \n\n\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scop"
},
{
"info": {
"name": "Update call queue details",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates information of a specific call queue. Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service, and so on.\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`"
},
{
"info": {
"name": "Delete a call queue",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "Unique identifier of the call queue."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.\n Use this API to delete a Call Queue.\n \n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Sc"
},
{
"info": {
"name": "Get call queue call handling setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/call_handling/settings",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
},
{
"name": "hour_type",
"value": "",
"type": "query",
"description": "The hour type of the call handling setting."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `hour_type` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `hour_type` is `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call handling setting of a call queue for the specified hour type.\n\n**Prerequisites**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):**"
},
{
"info": {
"name": "Update call queue call handling setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/call_handling/settings/:hourType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the call handling setting of a call queue for the specified hour type. Only the fields included in the request body are updated; omitted fields are left unchanged. Display-only fields (extension number/name, audio name, external contact name/email, Zoom Contact Center / Microsoft Teams display names) are derived on the server side and must not be sent in the request body.\n\n**Prerequisites:**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/"
},
{
"info": {
"name": "List custom groups of a call queue",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of custom groups for a call queue.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_custom_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Create a custom group in a call queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_custom_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Get call queue custom group detail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups/:customGroupId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
},
{
"name": "customGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the custom group."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_custom_group:admin`,`phone:read:call_queue_custom_group:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update a custom group",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups/:customGroupId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
},
{
"name": "customGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the custom group."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update a custom group.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_custom_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Delete a custom group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups/:customGroupId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue's unique identifier."
},
{
"name": "customGroupId",
"value": "",
"type": "path",
"description": "The custom group's unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete a custom group.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_custom_group:admin`,`phone:delete:call_queue_custom_group:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add members to a custom group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups/:customGroupId/members",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
},
{
"name": "customGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the custom group."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds call queue members to a custom group.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_custom_group_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Remove a member from a custom group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/custom_groups/:customGroupId/members/:extensionId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
},
{
"name": "customGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the custom group."
},
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The member's extension ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_custom_group_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "List call queue members",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/members",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID that is retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of call queue members.\n\n\n**Prerequisites:**\n\n* Pro, Business, or Education account\n* Account owner or admin permissions\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_queue_members:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIU"
},
{
"info": {
"name": "Add members to a call queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/members",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709) as members to a specific call queue.\n\n**Prerequisites:**\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/"
},
{
"info": {
"name": "Unassign all members",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/members",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes all members from a call queue who were previously assigned to that call queue. The members could be phone users or [common areas](https://support.zoom.us/hc/articles/4481136653709).\n\n**Prerequisites:**\n\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_member:admin`\n"
},
{
"info": {
"name": "Unassign a member",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/members/:memberId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "Unique identifier of the Call Queue from which the member needs to be unassigned."
},
{
"name": "memberId",
"value": "",
"type": "path",
"description": "Unique identifier of the member who needs to be unassigned."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes a member who was previously added to a call queue. The member could be a phone user or common area. Note that you cannot use this API to unassign a call queue manager. \n\n**Prerequisites:**\n\n* Pro or higher account plan.\n* Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_member:admin`\n\n**[Rate Limi"
},
{
"info": {
"name": "Assign numbers to a call queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/phone_numbers",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns numbers to a call queue. After [buying phone number(s)](https://support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it and allow callers to directly dial a number to reach a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).\n\n**Prerequisites:**\n- Pro or higher account plan\n* Account owner or admin permissions\n- Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes"
},
{
"info": {
"name": "Unassign all phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/phone_numbers",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unbinds all phone numbers that are assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). After successful unbinding, the numbers will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).\n \n If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. \n\n**Prerequisites:**\n* Pro or higher account palan\n* Account owner or admin permissions\n* Zoom Phone license \n\n \n\n**[Scopes](https://dev"
},
{
"info": {
"name": "Unassign a phone number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "The phone number ID. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unbinds a phone number from a call queue. After assigning a phone number, you can unbind it if you don't want it to be assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). After successful unbinding, the number will appear in the [Unassigned tab](https://zoom.us/signin#/numbers/unassigned).\n\n\n**Prerequisites:**\n* Pro or higher account palan\n* Account owner or admin permissions\n* Zoom Phone license \n\n \n\n**[Scopes](https://developers.zoom.us/doc"
},
{
"info": {
"name": "Get call queue policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/policies",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the policy setting of a specific [call queue].\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update call queue policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/policies",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The unique identifier of the call queue."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a call queue's policy settings.\n\n**Prerequisites**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add a policy subsetting to a call queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/policies/:policyType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID that is retrievable the [List Call Queues](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listCallQueues) API."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field corresponds to the policy sub-setting item you wish to add. \n\nAllowed values: `voice_mail`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the policy subsetting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use set up shared access members. \n\n**Prerequisites** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):"
},
{
"info": {
"name": "Update a call queue's policy subsetting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/policies/:policyType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID that is retrievable from the [List Call Queues](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listCallQueues) API."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "The field that corresponds to the policy sub-setting item you wish to update. Allowed values: `voice_mail`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the policy subsetting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to update shared access members.\n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-sco"
},
{
"info": {
"name": "Delete a CQ policy setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/policies/:policyType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID, retrievable from the [List Call Queues](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Call-Queues/operation/listCallQueues) API."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "Corresponds to tbe policy sub-setting item you wish to remove. Allowed values: `voice_mail`"
},
{
"name": "shared_ids",
"value": "",
"type": "query",
"description": "Comma separated list of shared IDs to remove. The number is limited to the minimum value of 10 or the number of allowed access members account setting."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove the policy sub-setting for a specific [call queue](https://support.zoom.us/hc/en-us/articles/360021524831) according to the `policyType`. For example, you can use this API to remove shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integ"
},
{
"info": {
"name": "Get call queue recordings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/recordings",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "Unique identifier of the Call Queue."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to view [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091#h_cbc9f2a3-e06c-4daa-83d4-ddbceef9c77b) from the call queue.\n\n\n**Prerequisites:**\n\n* Pro or higher account with Zoom Phone license.\n* [Automatic call recordings](https://support.zoom.us/hc/en-us/articles/360033511872#h_fcb297bb-14e8-4094-91ca-dc61e1a18734) must be enabled in the Policy Settings for call queues. \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone"
},
{
"info": {
"name": "Get call queue settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/settings",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
},
{
"name": "setting_type",
"value": "",
"type": "query",
"description": "The setting item to query. Defaults to `business_hours` if not provided. Allowed values: `holiday_hours`, `business_hours`, `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns call queue settings.\n\n**Prerequisites:**\n* Pro or higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_queue_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add call queue setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/settings/:settingType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item you want to add. Allowed values: `holiday_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a call queue setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_queue_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):*"
},
{
"info": {
"name": "Update call queue setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/settings/:settingType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item to modify. Allowed values: `holiday_hours`, `business_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the call queue setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_queue_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limi"
},
{
"info": {
"name": "Delete call queue setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/call_queues/:callQueueId/settings/:settingType",
"params": [
{
"name": "callQueueId",
"value": "",
"type": "path",
"description": "The call queue ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type to delete. Allowed values: `holiday_hours`, `break_hours`."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `settingType` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `settingType` is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete the call queue setting by the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_queue_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LI"
}
]
},
{
"info": {
"name": "Carrier Reseller",
"type": "folder"
},
"items": [
{
"info": {
"name": "List phone numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/carrier_reseller/numbers",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The size of the page."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of returned records."
},
{
"name": "assigned_status",
"value": "",
"type": "query",
"description": "Number assignment status."
},
{
"name": "sub_account_id",
"value": "",
"type": "query",
"description": "Partner account ID from sub-account."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "Partial string of the phone number."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to list phone numbers in a carrier reseller (master) account that can be pushed to its subaccounts.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_carrier_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-l"
},
{
"info": {
"name": "Create phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/carrier_reseller/numbers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add phone numbers to a carrier reseller (master) account. Up to 200 numbers at a time. If this API is called in MA mode, it also has functions of distribution.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:carrier_number:admin`\n\n**[Rate Limit L"
},
{
"info": {
"name": "Activate phone numbers",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/carrier_reseller/numbers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to change phone number status to 'active' in a carrier reseller's master account. Up to 200 numbers at a time.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:carrier_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-referenc"
},
{
"info": {
"name": "Delete a phone number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/carrier_reseller/numbers/:number",
"params": [
{
"name": "number",
"value": "",
"type": "path",
"description": "Phone number in E164 format."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete or unassign a phone number from a carrier reseller account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:carrier_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
}
]
},
{
"info": {
"name": "Common Areas",
"type": "folder"
},
"items": [
{
"info": {
"name": "List common areas",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The total number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through large result sets. 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."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See Managing multiple sites or Adding a site for details."
},
{
"name": "calling_type",
"value": "",
"type": "query",
"description": "The Zoom Phone [calling plan number](https://developers.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans)."
},
{
"name": "common_area_device_type",
"value": "",
"type": "query",
"description": "The common area device type:\n- 1 Smartphone\n\n- 2 Desk Phone\n\n- 3 Zoom Phone Appliance"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists common areas under an account.\n\n**Prerequisites**\n\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Add a common area",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an instance of a common area. You can configure devices shared by users and deployed in shared spaces.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/"
},
{
"info": {
"name": "Generate activation codes for common areas",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas/activation_code",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Generates activation codes for common areas. You can add up to 50 common areas at a time.\n\n**Prerequisites**\n- Pro or a higher account with Zoom Phone license\n- Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-l"
},
{
"info": {
"name": "List activation codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas/activation_codes",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The total number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of activation code information of the common areas under an account.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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_common_area_activation_codes:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-r"
},
{
"info": {
"name": "Apply template to common areas",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas/template_id/:templateId",
"params": [
{
"name": "templateId",
"value": "",
"type": "path",
"description": "The template ID is the unique identifier of the [Setting Template](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067442). \nYou can retrieve the identifier from the [List setting templates](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/listSettingTemplates) API.\nIf the account enabled [multiple sites](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069716#h_05c88e35-1593-491f-b1a8-b7139a75dc15), the setting template must belong to the same site as the common areas."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Applies a template to common areas. You can add up to 50 common areas at a time.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:apply_template_to_common_areas:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refe"
},
{
"info": {
"name": "Get common area details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns detailed information on the common area.\n\n**Prerequisites** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update common area",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the common area information.\n\n**Prerequisites**\n\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Delete a common area",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the common area. \n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Get common area call handling setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/call_handling/settings",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The unique identifier of the common area."
},
{
"name": "hour_type",
"value": "",
"type": "query",
"description": "The hour type of the call handling setting."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `hour_type` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `hour_type` is `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call handling setting of a common area for the specified hour type.\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_call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits)"
},
{
"info": {
"name": "Update common area call handling setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/call_handling/settings/:hourType",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The unique identifier of the common area."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the call handling setting of a common area for the specified hour type.\n\n**Prerequisites**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits"
},
{
"info": {
"name": "Assign calling plans to a common area",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/calling_plans",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns calling plans to a common area.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_calling_plan:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Unassign a calling plan from the common area",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/calling_plans/:type",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The Common area ID or common area extension ID."
},
{
"name": "type",
"value": "",
"type": "path",
"description": "The Zoom Phone [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to remove."
},
{
"name": "billing_account_id",
"value": "",
"type": "query",
"description": "The billing account ID. If the common area is in India, the parameter is required."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to unassign a calling plan from the common area.\n\n**Prerequisites:** \n* A Pro or higher account with a Zoom Phone license \n* An account owner or admin permissions \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_calling_plan:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limi"
},
{
"info": {
"name": "Assign phone numbers to a common area",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/phone_numbers",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns phone numbers to a common area.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Unassign phone numbers from common area",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "The phone number or the phone number ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns a phone number from a common area.\n\n**Prerequisites**\n* A Pro or a higher account with a Zoom Phone license\n* An account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT"
},
{
"info": {
"name": "Update common area pin code",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/pin_code",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the common area pin code.\n\n**Prerequisites**\n\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions, This depends on whether [The PIN cannot be viewed by the admin](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069783) is enabled. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone"
},
{
"info": {
"name": "Get common area settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/settings",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID."
},
{
"name": "setting_type",
"value": "",
"type": "query",
"description": "The setting item to query. Defaults to `desk_phone` if not provided. \n\nAllowed values: `desk_phone`, `holiday_hours`, `custom_hours`, `business_hours`, `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns common area settings.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_common_area_settings:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add common area setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/settings/:settingType",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting item to add. Allowed values: `desk_phone`, `holiday_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the common area setting according to the setting type.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):*"
},
{
"info": {
"name": "Update common area setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/settings/:settingType",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "This setting corresponds to the setting item you want to modify. Allowed values: `desk_phone`, `holiday_hours`, `business_hours`, `custom_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the common area setting according to the setting type.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limit"
},
{
"info": {
"name": "Delete common area setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/settings/:settingType",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The common area ID or common area extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type to delete. Allowed values: `desk_phone`, `holiday_hours`, `break_hours`."
},
{
"name": "device_id",
"value": "",
"type": "query",
"description": "The desk phone ID. You should complete the `desk_phone settingType`field."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. You should complete the `holiday_hours settingType`field."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `settingType` is `break_hours`. `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the common area subsetting from desk phones. \n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LI"
}
]
},
{
"info": {
"name": "Dashboard",
"type": "folder"
},
"items": [
{
"info": {
"name": "List call logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/call_logs",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "The start date in **yyyy-mm-dd** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 1 day."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This setting is **required** only when the `from` parameter is specified. The end date is in **yyyy-mm-dd** format, which is the same format as the `from` parameter."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site."
},
{
"name": "quality_type",
"value": "",
"type": "query",
"description": "This setting filters call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. \n \n The value of this field can be one of the following: \n \n* `good`: Retrieve call logs of the call(s) with good quality of voice. \n \n* `bad`: Retrieve call logs of the call(s) with good quality of voice. \n \n* `all`: Retrieve all call logs without filtering by voice quality. \n\n\n\n"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns monthly call logs metrics.\n\nThe call logs that provide a record of all incoming and outgoing calls over Zoom Phone in an account. \n\nYou can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call. \n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-s"
},
{
"info": {
"name": "Get call QoS",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/call_logs/:callId/qos",
"params": [
{
"name": "callId",
"value": "",
"type": "path",
"description": "The unique identifier of the call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets the call quality of service (QoS) data for a call made or received by a Zoom phone user in the account. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_qos:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#r"
},
{
"info": {
"name": "Get call details from call log",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/call_logs/:call_id",
"params": [
{
"name": "call_id",
"value": "",
"type": "path",
"description": "The unique identifier of the phone call. \nThe value of this field can be retrieved from [List Call Logs]() API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns call log details of a specific call. \n\nThe call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.\n\n **Prerequisites:**\n * Business, or Education account\n * Zoom Phone license \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`"
},
{
"info": {
"name": "List default emergency address users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/emergency_services/default_emergency_address/users",
"params": [
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of **Default Emergency Address**."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The name, email, or extension number of the user."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "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, and the maximu page number is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the users who provide a default personal emergency address rather than a default site address or default account address. \n\n**Prerequisites:** \n* Pro or higher account plan with Zoom phone license \n* Account owner or admin permissions\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:default_emergency_address:admin`\n\n**[Rate Limit"
},
{
"info": {
"name": "List detectable personal location users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/emergency_services/detectable_personal_location/users",
"params": [
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of **Detectable Personal Location**."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The name, email, or extension number of the user."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "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, and the maximum page number is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the users who created one or more detectable personal locations with associated network data. (Exclude users didn't enable Location Permission on client.) \n\n**Prerequisites:** \n* Pro or higher account plan with Zoom phone license \n* Account owner or admin permissions\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:detectable_perso"
},
{
"info": {
"name": "List users permission for location sharing",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/emergency_services/location_sharing_permission/users",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The name, email, or extension number of the user."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "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, and the maximum page number is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns users that have enabled location services and allowed location sharing with Zoom applications on client devices. \n\n(Excludes users who are unable to use Nomadic Emergency Services, or users on client versions lower than 5.4.0.) \n\n**Prerequisites:** \n* Pro or higher account plan with Zoom phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/"
},
{
"info": {
"name": "List nomadic emergency services users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/emergency_services/nomadic_emergency_services/users",
"params": [
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of **Nomadic Emergency Services is disabled**."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The name, email, or extension number of the user."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "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, and the max page number is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns users who have been enabled for nomadic emergency services.\n\n**Prerequisites:** \n* Pro or higher account plan with Zoom phone license \n* Account owner or admin permissions\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:nomadic_emergency_services:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limi"
},
{
"info": {
"name": "List real time location for IP phones",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/emergency_services/realtime_location/devices",
"params": [
{
"name": "location_type",
"value": "",
"type": "query",
"description": "The location's type. "
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The device name or device MAC address."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "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, and the maximum page number is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns currently detected location of IP phones.\n\n**Prerequisites:** \n* Pro or higher account plan with Zoom phone license \n* Account owner or admin permissions\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:realtime_location_devices:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** "
},
{
"info": {
"name": "List real time location for users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/emergency_services/realtime_location/users",
"params": [
{
"name": "location_type",
"value": "",
"type": "query",
"description": "The location's type."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The name, email or extension number of the user."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "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, and the max page number is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the user's currently detected location. (Excludes users who didn't enable location permission on the client.) \n\n**Prerequisites:** \n* Pro or higher account plan with Zoom phone license \n* Account owner or admin permissions\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:realtime_location_users:admin`\n\n**[Rate Limit Label](https:/"
},
{
"info": {
"name": "List tracked locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/location_tracking",
"params": [
{
"name": "type",
"value": "",
"type": "query",
"description": "The type of response data. Supports only six responses at this time.\n`1`: Nomadic Emergency Services.\n`2`: Users Permission for Location Sharing.\n`3`: Default Emergency Address.\n`4`: Detectable Personal Location.\n`5`: Real-time Location for Users.\n`6`: Real-time Location for IP Phones."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's ID."
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "The location's type. 'Company' is the default value."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The device name or device MAC address."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists the tracked locations. \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_tracked_locations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
{
"info": {
"name": "List past call metrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/metrics/past_calls",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "This setting filters call logs of a specified phone number."
},
{
"name": "extension_number",
"value": "",
"type": "query",
"description": "This setting filters call logs of a specified extension number"
},
{
"name": "quality_type",
"value": "",
"type": "query",
"description": "This setting filters call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality. \n \n The value of this field can be one of the following: \n \n* `good`: Retrieve call logs of the call(s) with good quality of voice. \n \n* `bad`: Retrieve call logs of the call(s) with good quality of voice. \n \n"
},
{
"name": "department",
"value": "",
"type": "query",
"description": "The department the extension belongs to."
},
{
"name": "cost_center",
"value": "",
"type": "query",
"description": "The cost center the extension belongs to."
},
{
"name": "directions",
"value": "",
"type": "query",
"description": "The directions of the call."
},
{
"name": "durations",
"value": "",
"type": "query",
"description": "The duration of the call. \n \n* `0`: The call that lasts 1 to 5 minutes. \n \n* `1`: The call that lasts 5 to 10 minutes. \n \n* `2`: The call that lasts more than 10 minutes. \n \n* `3`: The call that lasts less than 1 minute."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": " Returns all the call logs metrics of the account from the selected time period. The call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account. You can use query parameters to filter the response by metrics of the call (such as date, phone number, extension number and quality type). \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n"
}
]
},
{
"info": {
"name": "Device Line Keys",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get device line keys information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId/line_keys",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "The device ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get information on the Zoom Phone device [line keys](https://support.zoom.us/hc/en-us/articles/4402415568397-Customizing-keys-for-devices-with-multiple-users) settings and position.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read"
},
{
"info": {
"name": "Batch update device line key position",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId/line_keys",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "The device ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to batch update the Zoom Phone device [line key position](https://support.zoom.us/hc/en-us/articles/4402415568397-Customizing-keys-for-devices-with-multiple-users) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:dev"
}
]
},
{
"info": {
"name": "Dial by Name Directory",
"type": "folder"
},
"items": [
{
"info": {
"name": "List users in directory",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/dial_by_name_directory/extensions",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "in_directory",
"value": "",
"type": "query",
"description": "Whether the user belongs to the directory."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get users that are in or not in a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:directory:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.u"
},
{
"info": {
"name": "Add users to a directory",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/dial_by_name_directory/extensions",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add users to a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:directory:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refere"
},
{
"info": {
"name": "Delete users from a directory",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/dial_by_name_directory/extensions",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)"
},
{
"name": "extension_ids",
"value": "",
"type": "query",
"description": "Extension Ids. If the value is not specified, delete the value of `site_id` from `included sites` and delete all users related with `site_id` from directory."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete users from the [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:directory:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/ap"
},
{
"info": {
"name": "List users in a directory by site",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/dial_by_name_directory/extensions",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "in_directory",
"value": "",
"type": "query",
"description": "Whether the user belongs to the directory."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) to which users to get belongs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get users that are in or not in a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:directory:admin`\n\n**[Rate Limit Label](http"
},
{
"info": {
"name": "Add users to a directory of a site",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/dial_by_name_directory/extensions",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add users to a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:directory:admin`\n\n**[Rate Limit Label](https://marketplace.z"
},
{
"info": {
"name": "Delete users from a directory of a site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/dial_by_name_directory/extensions",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) to which users to delete belongs"
},
{
"name": "extension_ids",
"value": "",
"type": "query",
"description": "Extension Ids. If the value is not specified, delete the value of `site_id` from `included sites` and delete all users related with `site_id` from directory"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete users from a [directory](https://support.zoom.us/hc/en-us/articles/4404938949389-Using-a-dial-by-name-directory) of the specified site.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:directory:admin`\n\n**[Rate Limit Label](https://marketp"
}
]
},
{
"info": {
"name": "Emergency Addresses",
"type": "folder"
},
"items": [
{
"info": {
"name": "List emergency addresses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/emergency_addresses",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The emergency address site ID."
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "User ID to which the personal emergency address belongs."
},
{
"name": "level",
"value": "",
"type": "query",
"description": "The emergency address owner level:\n\n* `0` - Account/Company-level emergency address. \n\n* `1` - User/Personal-level emergency address.\n\n* `2` - Unknown company/pending emergency address."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The emergency address verification status: \n* `1` — Verification not Required. \n* `2` — Unverified. \n* `3` — Verification requested. \n* `4` — Verified. \n* `5` — Rejected. \n* `6` — Verification failed."
},
{
"name": "address_keyword",
"value": "",
"type": "query",
"description": "Keyword(s) to filter emergency addresses. You can filter by either: \n* Address Line 1. \n* Address Line 2. \n* City. \n* State Abbreviation. \n* Zip Code."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists the emergency addresses.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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_emergency_addresses:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
{
"info": {
"name": "Add an emergency address",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/emergency_addresses",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an emergency address. If the address provided is not an exact match, the system generated corrected address will be used. \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_address:admin`\n\n**[Rate Limit Label](https:"
},
{
"info": {
"name": "Get emergency address details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/emergency_addresses/:emergencyAddressId",
"params": [
{
"name": "emergencyAddressId",
"value": "",
"type": "path",
"description": "The emergency address ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets the emergency address information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_address:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Update an emergency address",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/emergency_addresses/:emergencyAddressId",
"params": [
{
"name": "emergencyAddressId",
"value": "",
"type": "path",
"description": "The ID of the emergency address."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates an emergency address information. If the address provided is not an exact match, the system generated corrected address will be used. \n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_address:admin`\n\n**[Rate Lim"
},
{
"info": {
"name": "Delete an emergency address",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/emergency_addresses/:emergencyAddressId",
"params": [
{
"name": "emergencyAddressId",
"value": "",
"type": "path",
"description": "The emergency address ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes an emergency address.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_address:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
}
]
},
{
"info": {
"name": "Emergency Service Locations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Batch add emergency service locations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/batch_locations",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds emergency service locations in batch. \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:batch_emergency_locations:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIG"
},
{
"info": {
"name": "List emergency service locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/locations",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through large result sets. 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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site. It can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. \n\n**Note:** When the account has been enabled Multiple Sites, this field is required."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns emergency service locations. \n**Note**: When you enable [multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites), the `site_id` parameter is required.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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/)"
},
{
"info": {
"name": "Add an emergency service location",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/locations",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an emergency service location.\n\n**Prerequisites** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:emergency_location:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Get emergency service location details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "",
"type": "path",
"description": "The emergency service location's ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an emergency service location's information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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:emergency_location:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Update emergency service location",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "",
"type": "path",
"description": "The emergency service location's ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates an emergency location's information.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:emergency_location:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Delete an emergency location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "",
"type": "path",
"description": "The emergency service location's ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes an emergency location.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:emergency_location:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
}
]
},
{
"info": {
"name": "External Contacts",
"type": "folder"
},
"items": [
{
"info": {
"name": "List external contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/external_contacts",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists the external contacts.\n\n**Prerequisites** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\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_external_contacts:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add an external contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/external_contacts",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an external contact.\n\n**Prerequisites** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:external_contact:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Get external contact details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/external_contacts/:externalContactId",
"params": [
{
"name": "externalContactId",
"value": "",
"type": "path",
"description": "The external contact's ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an external contact's information.\n\n**Prerequisites** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:external_contact:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update external contact",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/external_contacts/:externalContactId",
"params": [
{
"name": "externalContactId",
"value": "",
"type": "path",
"description": "The external contact ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates an external contact's information.\n\n**Prerequisites** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:external_contact:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Delete an external contact",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/external_contacts/:externalContactId",
"params": [
{
"name": "externalContactId",
"value": "",
"type": "path",
"description": "The external contact's ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes an external contact.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license \n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:external_contact:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
}
]
},
{
"info": {
"name": "Fax",
"type": "folder"
},
"items": [
{
"info": {
"name": "Upload fax file",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/fax/files",
"params": [
{
"name": "expire",
"value": "",
"type": "query",
"description": "The time to live in seconds for the uploaded file."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Uploads fax file\n\n**Note:**\n* Please use `https://fileapi.zoom.us` instead of `https://api.zoom.us`, the full path is `https://fileapi.zoom.us/v2/fax/files`\n* Supported file formats: `.zip`\n* The maximum size of file is 50MB\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:send_fax`,`phone:write:send_fax:admin`\n\n**[Rate Lim"
},
{
"info": {
"name": "Get extension's fax logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/fax/logs",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID of the fax log owner."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call.\n\nThe default is **30** and the maximum is **300**."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The token to retrieve the next page of results."
},
{
"name": "sender_number",
"value": "",
"type": "query",
"description": "ThesSender's fax number in E164 format."
},
{
"name": "receiver_number",
"value": "",
"type": "query",
"description": "The receiver's fax number in E164 format."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be one month, as the response only includes one month's worth of data at a time. "
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is **required** only when the `from` parameter is specified. \n\nThe end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the extension's fax logs.\n\n**Prerequisites**\n* User must belong to a Business or Enterprise account.\n* User must have a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log`,`phone:read:list_fax_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate"
},
{
"info": {
"name": "Send fax",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/fax/documents",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Sends a fax to receivers. \n\n**Prerequisites** \n* User must belong to a Business or Enterprise account. \n* User must have a Zoom Phone license.\n\n**Note:**\nFaxes sent through the API will first use the account-level page pool, if available. \n\nIf no page pool is available, pages meter individually. Unlimited faxing does not apply to faxes sent through the API.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](h"
},
{
"info": {
"name": "Get account's fax logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/fax/logs",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call.\n\nThe default is **30** and the maximum is **300**."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The token to retrieve the next page of results."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site's unique ID."
},
{
"name": "sender_number",
"value": "",
"type": "query",
"description": "The sender's fax number in E164 format."
},
{
"name": "receiver_number",
"value": "",
"type": "query",
"description": "The receiver's fax number in E164 format."
},
{
"name": "extension_type",
"value": "",
"type": "query",
"description": "The extension type of fax's log owner."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be one month as the response only includes one month's worth of data at a time. "
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is **required** only when the `from` parameter is specified. \n\nThe end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the account's fax logs.\n\n**Prerequisites**\n* User must belong to a Business or Enterprise account.\n* User must have 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_fax_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`"
},
{
"info": {
"name": "Get fax log details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/fax/logs/:faxLogId",
"params": [
{
"name": "faxLogId",
"value": "",
"type": "path",
"description": "The fax log's unique ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the fax log's details.\n\n**Prerequisites**\n* User must belong to a Business or Enterprise account.\n* User must have 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_fax_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update fax log read status",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/fax/logs/:faxLogId",
"params": [
{
"name": "faxLogId",
"value": "",
"type": "path",
"description": "The fax log's unique ID."
},
{
"name": "read_status",
"value": "",
"type": "query",
"description": "The fax log's read status."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the read status of a specific fax log.\n\n**Prerequisites**\n* User must belong to a Business or Enterprise account.\n* User must have a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_log:admin`,`phone:read:fax_log`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#r"
},
{
"info": {
"name": "Delete fax log",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/fax/logs/:faxLogId",
"params": [
{
"name": "faxLogId",
"value": "",
"type": "path",
"description": "The fax log's unique ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a specific fax log.\n\n**Prerequisites**\n* User must belong to a Business or Enterprise account.\n* User must have a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:fax_log`,`phone:delete:fax_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):*"
},
{
"info": {
"name": "Download fax file",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/fax/logs/:faxLogId/file/:fileId",
"params": [
{
"name": "faxLogId",
"value": "",
"type": "path",
"description": "The fax log's unique ID."
},
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The fax file ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Downloads the fax file.\n\n**Prerequisites*\n* User must belong to a Business or Enterprise account.\n* User must have a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:fax_log`,`phone:read:fax_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE"
}
]
},
{
"info": {
"name": "Firmware Update Rules",
"type": "folder"
},
"items": [
{
"info": {
"name": "List firmware update rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/firmware_update_rules",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Required if multiple sites are enabled."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get [firmware update rules](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_firmware_update_rules:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.u"
},
{
"info": {
"name": "Add a firmware update rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/firmware_update_rules",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add a [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:firmware_update_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/"
},
{
"info": {
"name": "Get firmware update rule information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/firmware_update_rules/:ruleId",
"params": [
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "Unique identifier of the firmware update rule."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get the [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules) information.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:firmware_update_rule:admin`\n\n**[Rate Limit Label](https://marketpla"
},
{
"info": {
"name": "Update firmware update rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/firmware_update_rules/:ruleId",
"params": [
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "Unique identifier of the firmware update rule."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to update a specific [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:firmware_update_rule:admin`\n\n**[Rate Limit Label](https://marketp"
},
{
"info": {
"name": "Delete firmware update rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/firmware_update_rules/:ruleId",
"params": [
{
"name": "ruleId",
"value": "",
"type": "path",
"description": "Unique identifier of the firmware update rule."
},
{
"name": "restart_type",
"value": "",
"type": "query",
"description": "Restart type: `1` - Restart the devices immediately. `2` - Restart with the next resync or auto pull."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete the [firmware update rule](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:firmware_update_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoo"
},
{
"info": {
"name": "List updatable firmwares",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/firmwares",
"params": [
{
"name": "is_update",
"value": "",
"type": "query",
"description": "Firmware update rule enabled. \n `true` - Get all firmwares that can have firmware update rules added \n `false` - Get all firmwares whether or not you can add firmware update rules to it"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Required if multiple sites are enabled."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get updatable [firmwares](https://support.zoom.us/hc/en-us/articles/360054198852-Setting-up-firmware-update-rules).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_firmwares:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-ref"
}
]
},
{
"info": {
"name": "Group Call Pickup",
"type": "folder"
},
"items": [
{
"info": {
"name": "List group call pickup objects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/group_call_pickup",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to retrieve a list of [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) objects in an account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_pickup_groups:admin`\n\n**[Rate L"
},
{
"info": {
"name": "Add a group call pickup object",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/group_call_pickup",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add a [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) instance to the account that has the Zoom Phone license assigned. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_pic"
},
{
"info": {
"name": "Get call pickup group by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/group_call_pickup/:groupId",
"params": [
{
"name": "groupId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to retrieve information on a specific [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object in an account. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_pickup_group:admin`\n"
},
{
"info": {
"name": "Update the group call pickup information",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/group_call_pickup/:groupId",
"params": [
{
"name": "groupId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to update a specific [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object information.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_pickup_group:admin`\n\n**[Rate Limit La"
},
{
"info": {
"name": "Delete group call pickup objects",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/group_call_pickup/:groupId",
"params": [
{
"name": "groupId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove a [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_pickup_group:admin`\n\n**[Rate Limit Label](https://marketpl"
},
{
"info": {
"name": "List call pickup group members",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/group_call_pickup/:groupId/members",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "groupId",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the site."
},
{
"name": "extension_type",
"value": "",
"type": "query",
"description": "Type of the assignee."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to retrieve members of a [call pickup group](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) in an account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_pickup_group_member:admin`\n\n**[Rate Limit"
},
{
"info": {
"name": "Add members to a call pickup group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/group_call_pickup/:groupId/members",
"params": [
{
"name": "groupId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add members to the specified [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:call_pickup_group_member:admin`\n\n**[Rate Li"
},
{
"info": {
"name": "Remove members from call pickup group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/group_call_pickup/:groupId/members/:extensionId",
"params": [
{
"name": "groupId",
"value": "",
"type": "path"
},
{
"name": "extensionId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove member from the [Group Call Pickup](https://support.zoom.us/hc/en-us/articles/360060107472-Setting-up-and-using-group-call-pickup) object. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_pickup_group_member:admin`\n\n**[Rate Limit L"
}
]
},
{
"info": {
"name": "Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get group policy details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/groups/:groupId/policies/:policyType",
"params": [
{
"name": "groupId",
"value": "",
"type": "path",
"description": "The user group ID."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field specifies the policy type to retrieve or modify. See the documentation for detailed behavior of each policy type.\n\nSupported values:\n- `allow_emergency_calls`: Controls whether emergency calls are allowed."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the group policy details.\n\n**Prerequisites**\nPro or higher account plan with 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:group_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Update group policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/groups/:groupId/policies/:policyType",
"params": [
{
"name": "groupId",
"value": "",
"type": "path",
"description": "The user group ID."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field specifies the policy type to retrieve or modify. See the documentation for detailed behavior of each policy type.\n\nSupported values:\n- `allow_emergency_calls`: Controls whether emergency calls are allowed."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the group policy.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:group_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`"
},
{
"info": {
"name": "Get group phone settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/groups/:groupId/settings",
"params": [
{
"name": "groupId",
"value": "",
"type": "path",
"description": "The group ID. \n\nIt can be retrieved from the [List groups](/docs/api/rest/reference/zoom-api/methods/#operation/groups) API."
},
{
"name": "setting_types",
"value": "",
"type": "query",
"description": "This setting corresponds to the setting item you want to modify. \n\nComma separated. \n\n**Allowed values**\n* `call_live_transcription`\n* `local_survivability_mode`\n* `select_outbound_caller_id`\n* `personal_audio_library`\n* `voicemail`\n* `voicemail_transcription`\n* `voicemail_notification_by_email`\n* `shared_voicemail_notification_by_email`\n* `restricted_call_hours`\n* `allowed_call_locations`\n* `check_voicemails_over_phone`, `connect_to_operator`\n* `auto_call_recording`\n* `ad_hoc_call_recording`\n* `outbound_calling`\n* `outbound_sms`\n* `international_calling`\n* `sms`\n* `zoom_phone_on_mobile`\n* `zoom_phone_on_pwa`\n* `sms_etiquette_tool`\n* `e2e_encryption`\n* `call_handling_forwarding`\n* `call_overflow`\n* `call_transferring`\n* `elevate_to_meeting`\n* `call_park`\n* `hand_off_to_room`\n* `mobile_switch_to_carrier`\n* `delegation`\n* `audio_intercom`\n* `block_list_for_inbound_calls_and_messaging`\n* `block_calls_without_caller_id`\n* `block_external_calls`\n* `peer_to_peer_media`\n* `advanced_encryption`\n* `display_call_feedback_survey`\n* `allow_emergency_calls`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns group phone settings.\n\n**Prerequisites**\n Account must have a Pro or a higher plan with 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:group_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
}
]
},
{
"info": {
"name": "IVR",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get auto receptionist IVR",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/ivr",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The unique identifier of the auto receptionist. You can retrieve it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API."
},
{
"name": "hours_type",
"value": "",
"type": "query",
"description": "The type of query hours."
},
{
"name": "holiday_id",
"value": "",
"type": "query",
"description": "The auto receptionist holiday hours ID. If both `holiday_id` and `hours_type` are passed, `holiday_id` has the highest priority and `hours_type` is ignored."
},
{
"name": "break_id",
"value": "",
"type": "query",
"description": "The auto receptionist break hours ID. Required when `hours_type` is `break_hours`. If `holiday_id` is also passed, `holiday_id` takes precedence."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an [interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist.\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:auto_receptionist_ivr:admin`\n\n**[Rate Limit Label](https://marketpl"
},
{
"info": {
"name": "Update auto receptionist IVR",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/auto_receptionists/:autoReceptionistId/ivr",
"params": [
{
"name": "autoReceptionistId",
"value": "",
"type": "path",
"description": "The auto receptionist ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the [interactive voice response (IVR) system](https://support.zoom.us/hc/en-us/articles/360038601971) of the specified auto receptionist.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:auto_receptionist_ivr:admin`\n\n**[Rate Limit Label](https://mark"
}
]
},
{
"info": {
"name": "Inbound Blocked List",
"type": "folder"
},
"items": [
{
"info": {
"name": "List an extension's inbound block rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/inbound_blocked/rules",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID for the inbound blocked rules to fetch."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type for the block rule:\n* `phoneNumber`: Only a specific phone number that is shown in the `blocked_number` field is blocked.\n* `prefix`: All numbers starting with the prefix that is shown in the `blocked_number` field are blocked.\n* `SMS-shortCodes`: Only a specific SMS short code that is shown in the `blocked_number` field is blocked.\n* `countryCode`: All numbers that match the country code of the `country` field are blocked."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The block type for the block rule:\n* `block_for_other_reasons`\n* `block_as_threat`"
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of the given extension's block rule for inbound calls and messaging. \n\nit lists inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room, or User.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:rea"
},
{
"info": {
"name": "Add an extension's inbound block rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/inbound_blocked/rules",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID for the inbound blocked rules to fetch."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the given extension's block rule for inbound calls and messaging. \n\nIt adds the inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room or User.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:extens"
},
{
"info": {
"name": "Delete an extension's inbound block rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/inbound_blocked/rules",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID for the inbound blocked rules to fetch."
},
{
"name": "blocked_rule_id",
"value": "",
"type": "query",
"description": "The unique identifier of the blocked rule. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the given extension's blocked rule for inbound calls and messaging. \n\nUse this API to delete inbound blocked rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room or User.\n\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** "
},
{
"info": {
"name": "List an account's inbound blocked statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/extension_rules/statistics",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type for the block rule:\n* `phoneNumber`: Only a specific phone number that is shown in the `blocked_number` field is blocked.\n* `prefix`: All numbers starting with the prefix that is shown in the `blocked_number` field are blocked.\n* `SMS-shortCodes`: Only a specific SMS short code that is shown in the `blocked_number` field is blocked.\n* `countryCode`: All numbers that match the country code of the `country` field are blocked."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The block type for the block rule:\n* block_for_other_reasons\n* block_as_threat"
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the list of the statistics of the extensions blocked rule for inbound calls and messaging. (e.g. Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room and User)\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\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"
},
{
"info": {
"name": "Delete an account's inbound blocked statistics",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/extension_rules/statistics",
"params": [
{
"name": "blocked_statistic_id",
"value": "",
"type": "query",
"description": "The unique identifier of the blocked statistic."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the statistic of extensions blocked rule for inbound calls and messaging. (e.g. Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room and User)\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:extensio"
},
{
"info": {
"name": "Mark a phone number as blocked for all extensions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/extension_rules/statistics/blocked_for_all",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Promotes and applies the phone number blocked from the extension level blocked rule to the account level blocked rule. This action is contingent on the statistics of extensions blocked rule. All extensions under the current account block this phone number.\n\n**Prerequisites:**\n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https:/"
},
{
"info": {
"name": "List an account's inbound block rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/rules",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type for the block rule:\n* `phoneNumber`: Indicates that only a specific phone number that is shown in the `blocked_number` field is blocked.\n* `prefix`: Indicates that all numbers starting with the prefix that is shown in the `blocked_number` field are blocked.\n* `SMS-shortCodes`: Indicates that only a specific SMS short code that is shown in the `blocked_number` field is blocked.\n* `countryCode`: Indicates that all numbers that match the country code of the `country` field are blocked."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The block type for the block rule:\n* block_for_other_reasons\n* block_as_threat"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Whether the block rule is active or inactive.\n* `active`: The block rule is active.\n* `inactive`: The block rule is inactive."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of account level inbound block rule for inbound calls and messaging.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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_inbound_block_rules:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/"
},
{
"info": {
"name": "Add an account's inbound block rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/rules",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an account level block rule for inbound calls and messaging from a phone number. As a result, all extensions block calls and messages to the phone number.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:inbound_block_rule:admi"
},
{
"info": {
"name": "Delete an account's inbound block rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/rules",
"params": [
{
"name": "blocked_rule_id",
"value": "",
"type": "query",
"description": "The unique identifier of the blocked rule. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the account level blocked rule for inbound calls and messaging.\n\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:inbound_block_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#ra"
},
{
"info": {
"name": "Update an account's inbound block rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/inbound_blocked/rules/:blockedRuleId",
"params": [
{
"name": "blockedRuleId",
"value": "",
"type": "path",
"description": "The unique identifier of the blocked rule."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the account level block rule for inbound calls and messaging.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:inbound_block_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-"
}
]
},
{
"info": {
"name": "Line Keys",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get line key position and settings information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/line_keys",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:line_keys`,`phone:read:line_keys:admin`\n\n**[Rate Limit Label](https://mar"
},
{
"info": {
"name": "Batch update line key position and settings information",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/line_keys",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to batch update the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:line_keys`,`phone:update:line_keys:admin`\n\n**[Rate Limit Lab"
},
{
"info": {
"name": "Delete a line key setting.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/extension/:extensionId/line_keys/:lineKeyId",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The extension ID."
},
{
"name": "lineKeyId",
"value": "",
"type": "path",
"description": "Line key ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete the Zoom Phone [line key settings](https://support.zoom.us/hc/en-us/articles/360040587552) information.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:line_keys`,`phone:delete:line_keys:admin`\n\n**[Rate Limit Label](ht"
}
]
},
{
"info": {
"name": "Monitoring Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a list of monitoring groups on an account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/monitoring_groups",
"params": [
{
"name": "type",
"value": "",
"type": "query",
"description": "The monitoring group's type."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the monitoring group's site."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The size of the page."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of returned records."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's [monitoring group](https://support.zoom.us/hc/en-us/articles/360044804711) list.\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_monitoring_groups:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits"
},
{
"info": {
"name": "Create a monitoring group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/monitoring_groups",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a [monitoring group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:monitoring_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LI"
},
{
"info": {
"name": "Get monitoring group by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "The monitoring group ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a [monitoring group](https://support.zoom.us/hc/en-us/articles/360044804711) for the specified ID.\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:monitoring_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#"
},
{
"info": {
"name": "Update a monitoring group",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "Monitoring group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to update a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:monitoring_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rat"
},
{
"info": {
"name": "Delete a monitoring group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "Monitoring group ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:monitoring_group:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rat"
},
{
"info": {
"name": "Get members of a monitoring group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId/monitor_members",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "Monitoring group ID."
},
{
"name": "member_type",
"value": "",
"type": "query",
"description": "Member type"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The size of the page."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of returned records."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to return members list of a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\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_monitoring_group_members:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api"
},
{
"info": {
"name": "Add members to a monitoring group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId/monitor_members",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "Monitoring group ID."
},
{
"name": "member_type",
"value": "",
"type": "query",
"description": "Member type"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add members to a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:monitoring_group_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/r"
},
{
"info": {
"name": "Remove all monitors or monitored members from a monitoring group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId/monitor_members",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "Monitoring group ID."
},
{
"name": "member_type",
"value": "",
"type": "query",
"description": "Member type"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove all monitor or monitored members from a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:monitoring_group_member:admin`\n\n**[Rate Limit Label](https://marketpla"
},
{
"info": {
"name": "Remove a member from a monitoring group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/monitoring_groups/:monitoringGroupId/monitor_members/:memberExtensionId",
"params": [
{
"name": "monitoringGroupId",
"value": "",
"type": "path",
"description": "Monitoring group ID."
},
{
"name": "memberExtensionId",
"value": "",
"type": "path",
"description": "Member's extension ID."
},
{
"name": "member_type",
"value": "",
"type": "query",
"description": "Member type"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove a member from a [Monitoring Group](https://support.zoom.us/hc/en-us/articles/360044804711).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:monitoring_group_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refe"
}
]
},
{
"info": {
"name": "Outbound Calling",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get common area level outbound calling countries and regions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/outbound_calling/countries_regions",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The ID of the common area."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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):** `LIGH"
},
{
"info": {
"name": "Update common area level outbound calling countries or regions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/outbound_calling/countries_regions",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The ID of the common area."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the common area level outbound calling policy country or region.\n\n**Prerequisite:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-"
},
{
"info": {
"name": "List common area level outbound calling exception rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/outbound_calling/exception_rules",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The ID of the common area."
},
{
"name": "country",
"value": "",
"type": "query",
"description": "The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type of an exception rule."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of an exception rule."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists the common area level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with 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):** `MEDIUM`"
},
{
"info": {
"name": "Add common area level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/outbound_calling/exception_rules",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The ID of the common area."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the common area level outbound calling policy exception rule for the country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:common_area_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/do"
},
{
"info": {
"name": "Update common area level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The ID of the common area."
},
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the common area level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:common_area_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.u"
},
{
"info": {
"name": "Delete common area level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/common_areas/:commonAreaId/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "commonAreaId",
"value": "",
"type": "path",
"description": "The ID of the common area."
},
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the common area level outbound calling exception rule.\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:common_area_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limit"
},
{
"info": {
"name": "Get account level outbound calling countries and regions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/outbound_calling/countries_regions",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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`"
},
{
"info": {
"name": "Update account level outbound calling countries or regions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/outbound_calling/countries_regions",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the account level outbound calling policy country or region.\n\n**Prerequisite:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGH"
},
{
"info": {
"name": "List account level outbound calling exception rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/outbound_calling/exception_rules",
"params": [
{
"name": "country",
"value": "",
"type": "query",
"description": "The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type of an exception rule."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of an exception rule."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists the account level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with 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):** `MEDIUM`"
},
{
"info": {
"name": "Add account level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/outbound_calling/exception_rules",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the account level outbound calling policy exception rule for country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rat"
},
{
"info": {
"name": "Update account level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the account level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refer"
},
{
"info": {
"name": "Delete account level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the account level outbound calling exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):"
},
{
"info": {
"name": "Get site level outbound calling countries and regions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_calling/countries_regions",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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`"
},
{
"info": {
"name": "Update site level outbound calling countries or regions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_calling/countries_regions",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the site level outbound calling policy country or region.\n\n**Prerequisites:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `L"
},
{
"info": {
"name": "List site level outbound calling exception rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_calling/exception_rules",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "country",
"value": "",
"type": "query",
"description": "The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type of an exception rule."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of an exception rule."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of site level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with 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):** `MEDIUM`"
},
{
"info": {
"name": "Add site level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_calling/exception_rules",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the site level outbound calling policy exception rule for the country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:site_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-referen"
},
{
"info": {
"name": "Update site level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the site level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-ref"
},
{
"info": {
"name": "Delete site level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The ID of the site."
},
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the site level outbound calling exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:site_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits"
},
{
"info": {
"name": "Get user level outbound calling countries and regions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_calling/countries_regions",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the user 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:user_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update user level outbound calling countries or regions",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_calling/countries_regions",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the user level outbound calling policy country or region.\n\n**Prerequisite:**\n* Account must have a Pro or a higher plan with a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LI"
},
{
"info": {
"name": "List user level outbound calling exception rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_calling/exception_rules",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user."
},
{
"name": "country",
"value": "",
"type": "query",
"description": "The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of a phone number."
},
{
"name": "match_type",
"value": "",
"type": "query",
"description": "The match type of an exception rule."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of an exception rule."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records in a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of the user level outbound calling policy exception rules.\n\n**Prerequisite:**\n* Pro or higher account plan with 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:user_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Add user level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_calling/exception_rules",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an user level outbound calling policy exception rule for the country region.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-referenc"
},
{
"info": {
"name": "Update user level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user."
},
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the user level outbound calling policy for the country region exception rule.\n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-"
},
{
"info": {
"name": "Delete user level outbound calling exception rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_calling/exception_rules/:exceptionRuleId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user."
},
{
"name": "exceptionRuleId",
"value": "",
"type": "path",
"description": "The exception rule ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the user level outbound calling exception rule.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_outbound_calling_rule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits"
}
]
},
{
"info": {
"name": "Phone Devices",
"type": "folder"
},
"items": [
{
"info": {
"name": "List devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/devices",
"params": [
{
"name": "type",
"value": "",
"type": "query",
"description": "The device status: `assigned` or `unassigned` to list device status in Zoom account."
},
{
"name": "assignee_type",
"value": "",
"type": "query",
"description": "The type of the assignee. It's available if `type = assigned`. It's unavailable if the account has not enabled the common area feature. It also returns devices of the specified `assignee_type`. If unspecified, it returns all assigned devices."
},
{
"name": "device_source",
"value": "",
"type": "query",
"description": "The device source. `hotDesking` is only available when `type = assigned`."
},
{
"name": "location_status",
"value": "",
"type": "query",
"description": "The status of device location. It's available if `type = assigned`."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site of the assignee."
},
{
"name": "device_type",
"value": "",
"type": "query",
"description": "The manufacturer name or device type."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The user, extension, MAC address, or IP address to filter the results."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account.\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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_devices:admin`\n\n**[Rate Limit Labe"
},
{
"info": {
"name": "Add a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/devices",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Adds an unassigned desk phone or an assigned (to a user or a common area) desk phone.](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061431#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da)\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices) \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overvi"
},
{
"info": {
"name": "Sync deskphones",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/devices/sync",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to resync all online zero-touch or assisted-provisioning devices in an account or a site. Only allows sending one request every 15 minutes.\n\n**Prerequisites:**\n\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:sync_device:admin`\n\n**[Rate "
},
{
"info": {
"name": "Get device details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "The unique Identifier of the device."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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:device:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.u"
},
{
"info": {
"name": "Update a device",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "The unique identifier of the device."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license* Account owner or admin permissions\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:device:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refe"
},
{
"info": {
"name": "Delete a device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "Unique identifier of the device."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Remove a [desk phone device or ATA (Analog Telephone Adapter)](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* Device must not have been assigned to a user.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-ov"
},
{
"info": {
"name": "Assign an entity to a device",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId/extensions",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "Unique identifier of the device."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to [add a desk phone and assign it to a user](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-"
},
{
"info": {
"name": "Unassign an entity from the device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId/extensions/:extensionId",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "Unique identifier of the device from which to unassign an assignee."
},
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "Extension ID of the assignee (`user` or `common area`)"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to unassign a specific assignee from the device.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:device_extension:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits"
},
{
"info": {
"name": "Update provision template of a device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId/provision_templates",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "The device ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to [assign a provision template to a device](https://support.zoom.us/hc/en-us/articles/360035817952#h_6b52ef26-d070-40ed-a3fa-520571944afc) or [remove a provision template from the device](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) by leaving `templateId` empty.\n\n**Prerequisites:** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n* [Supported device](https://support.zoom.us/hc/en-us/article"
},
{
"info": {
"name": "Reboot a desk phone",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/devices/:deviceId/reboot",
"params": [
{
"name": "deviceId",
"value": "",
"type": "path",
"description": "Unique identifier of the device."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to reboot an online zero-touch or assisted-provisioning device. You can only send one request every second.\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:reboot_device:admin`\n\n**[Rate Limit Label](https://marketp"
},
{
"info": {
"name": "List Smartphones",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/smartphones",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site of the assignee."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The device name, common area, serial number, or IP address to filter the results."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of all the [smartphones](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074058) configured with Zoom Phone on an account.\n\n**Prerequisites** \n \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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_devices:admin`\n\n**[R"
}
]
},
{
"info": {
"name": "Phone Numbers",
"type": "folder"
},
"items": [
{
"info": {
"name": "Add BYOC phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/byoc_numbers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.\n\n**Prerequisites** \n* A Business or Enterprise plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:byo_carrier_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "List phone numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/numbers",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "The query response by number assignment. The value can be one of the following:\n \n \n`assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist, or a common area in an account. \n `unassigned`: The number is not assigned to anyone. \n \n`all`: Include both assigned and unassigned numbers in the response. \n \n`byoc`: Include Bring Your Own Carrier (BYOC) numbers only in the response."
},
{
"name": "extension_type",
"value": "",
"type": "query",
"description": "The type of assignee to whom the number is assigned. The parameter can be set only if `type` parameter is set as `assigned`. The value can be one of the following: \n \n`user` \n `callQueue` \n `autoReceptionist` \n `commonArea` \n `emergencyNumberPool` \n `companyLocation` \n `meetingService`"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "number_type",
"value": "",
"type": "query",
"description": "The type of phone number. The value can be either `toll` or `tollfree`."
},
{
"name": "pending_numbers",
"value": "",
"type": "query",
"description": "This field includes or excludes pending numbers in the response. The value can be either `true` or `false`."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details."
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "The phone number in E164 format."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list all Zoom Phone numbers in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Delete unassigned phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/numbers",
"params": [
{
"name": "phone_numbers",
"value": "",
"type": "query",
"description": "Comma seperated list of unassigned phone numbers in E164 format or phone number IDs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be removed in a single request.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The user must have been previously assigned a Zoom Phone number\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://devel"
},
{
"info": {
"name": "Update a site's unassigned phone numbers",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/numbers/sites/:siteId",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "Unique identifier of the site"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a site's unassigned [phone numbers](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). Up to 20 phone numbers can be updated in a single request. \n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `p"
},
{
"info": {
"name": "Get a phone number",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/numbers/:phoneNumberId",
"params": [
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "The unique identifier of the phone number retrieved from the List phone numbers API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information about an account's Zoom Phone number.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update a phone number",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/numbers/:phoneNumberId",
"params": [
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "The unique identifier of the phone number."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a Zoom Phone number's information.\n\n**Prerequisites:** \n* A Paid account\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Assign a phone number to a user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/phone_numbers",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone.**Prerequisites:** * A Business or Enterprise account * A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_number`,`phone:write:user_number:admin`\n\n**[R"
},
{
"info": {
"name": "Unassign a phone number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "This field provides either the user ID or email address of the user."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "This field provides either the phone number or phone number ID of the user. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns Zoom Phone user's [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6).\n\nAfter assigning a phone number, you can remove it if you do not want it to be assigned to anyone.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The user must have been previously assigned a Zoom Phone number\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:w"
}
]
},
{
"info": {
"name": "Phone Plans",
"type": "folder"
},
"items": [
{
"info": {
"name": "List calling plans",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/calling_plans",
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns all of an account's Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans).\n\n**Prerequisites** \n* A Pro or a higher 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_calling_plans:admin`\n\n**[Rate Limit Label](https://marketplace."
},
{
"info": {
"name": "List plan information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/plans",
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns all of an account's Zoom Phone [plan package](https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans-and-codes), phone number usage, and availability.\n\n**Prerequisites** \n* A Pro or a higher account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_calling_pla"
}
]
},
{
"info": {
"name": "Phone Roles",
"type": "folder"
},
"items": [
{
"info": {
"name": "List phone roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/roles",
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the phone roles.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_roles:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Duplicate a phone role",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/roles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to duplicate a phone role.\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Get role information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/roles/:roleId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "The role ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get information on a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refe"
},
{
"info": {
"name": "Update a phone role",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/roles/:roleId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to update a role.\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Delete a phone role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/roles/:roleId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rat"
},
{
"info": {
"name": "List members in a role",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/roles/:roleId/members",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
},
{
"name": "in_role",
"value": "",
"type": "query",
"description": "Whether the user belongs to the role: default is `false`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get members (not) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:role_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-re"
},
{
"info": {
"name": "Add members to roles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/roles/:roleId/members",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add members to [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management#h_01EFHY1R4QWAYTA6Z661NM9Q27).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:role_member:admin`\n\n**[Rate Limit Label](https://marketp"
},
{
"info": {
"name": "Delete members in a role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/roles/:roleId/members",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
},
{
"name": "user_ids",
"value": "",
"type": "query",
"description": "The user IDs or email addresses of the user"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to delete member(s) in a [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:role_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-"
},
{
"info": {
"name": "List phone role targets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/roles/:roleId/targets",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
},
{
"name": "is_default",
"value": "",
"type": "query",
"description": "If`is_default`=`true`, it manages the role default targets.\nIf `is_default`=`false`, it manages the role member targets."
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "The role member ID. It's required if `is_default`=`false`."
},
{
"name": "selected",
"value": "",
"type": "query",
"description": "`selected`=`true`filters the targets that are in the role.\n `selected`=`false` filters the targets that are not in the role."
},
{
"name": "target_type",
"value": "",
"type": "query",
"description": "The target type. \n\nDifferent types of roles manage different types of targets: \n\n * super_admin: need not manage targets. \n\n * site_admin: support site type. \n\n * callQueue_admin: support callQueue type. \n\n * autoReceptionist_admin: support autoReceptionist type. \n\n * sharedLineGroup_admin: support sharedLineGroup type. \n\n * commonArea_admin: support site type. \n\n * recording_admin: support site, callQueue, autoReceptionist, user, group types. \n\n * compliance_admin: support site, callQueue, user, group, sharedLineGroup, commonArea types."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The keyword of the name or extension ID. It provides the ability to search by keyword."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Targets of a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management). \r\n\r\n**Prerequisites:** \r\n* Business or Education account \r\n* Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_roles:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limi"
},
{
"info": {
"name": "Add phone role targets",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/roles/:roleId/targets",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds targets to phone [roles](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rat"
},
{
"info": {
"name": "Delete phone role targets",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/roles/:roleId/targets",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "The unique identifier of the [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management) assigned to the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the targets of a phone [role](https://support.zoom.us/hc/en-us/articles/360042099012-Using-Zoom-Phone-role-management).\r\n\r\n**Prerequisites:**\r\n* Business or Education account\r\n* Zoom Phone license \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:role:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/ra"
}
]
},
{
"info": {
"name": "Private Directory",
"type": "folder"
},
"items": [
{
"info": {
"name": "List private directory members",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/private_directory/members",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of the private directory's member number. It only supports suffix fuzzy matching for the extension number."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) that you would like to use for the private directory. This field is required only if the multiple sites option has been enabled for the account."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the member list of a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992).\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_private_directory_members:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Add members to a private directory",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/private_directory/members",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds members to a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:private_directory_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update a private directory member",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/private_directory/members/:extensionId",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The member's extension ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a member of a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:private_directory_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Remove a member from a private directory",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/private_directory/members/:extensionId",
"params": [
{
"name": "extensionId",
"value": "",
"type": "path",
"description": "The member's extension ID."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) that you would like to use for the private directory. This field is required only if the multiple sites option has been enabled for the account."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes a member from a [private directory](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063992).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:private_directory_member:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
}
]
},
{
"info": {
"name": "Provider Exchange",
"type": "folder"
},
"items": [
{
"info": {
"name": "List carrier peering phone numbers.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/carrier_peering/numbers",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The total number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "This field filters results by the given phone number."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns phone numbers that the carrier pushed to different customers.\nTo become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\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`,`phone_peering:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/inte"
},
{
"info": {
"name": "List peering phone numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/peering/numbers",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The total number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "The sender's or receiver's phone number that limits the list of SMS sessions."
},
{
"name": "carrier_code",
"value": "",
"type": "query",
"description": "The carrier's code. The `clientId` that maps to a carrier peered with Zoom.\n\nThis parameter is required if you do **not** use an OAuth token or the OAuth token does not contain the `clientId`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns phone numbers to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\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:re"
},
{
"info": {
"name": "Add peering phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/peering/numbers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds phone numbers to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write"
},
{
"info": {
"name": "Update peering phone numbers",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/peering/numbers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates phone numbers to Zoom through the Provider Exchange.\n\n**Note**: Phone peering API and events are for partners that have completed the MoU to peer with Zoom. To become a peering provider/ carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\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:w"
},
{
"info": {
"name": "Remove peering phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/peering/numbers",
"params": [
{
"name": "carrier_code",
"value": "",
"type": "query",
"description": "The carrier's code. The `clientId` maps to a carrier peered with Zoom. This parameter is required if you do **not** use an OAuth token or the OAuth token does not contain the `clientId`."
},
{
"name": "phone_numbers",
"value": "",
"type": "query",
"description": "The information about the removed phone numbers. Maximum of 200."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes phone numbers added to Zoom through the provider exchange.\n\n**Note**: Phone peering API and events are for partners who have completed the MoU to peer with Zoom. To become a peering provider or carrier, submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\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/):** `"
}
]
},
{
"info": {
"name": "Provision Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "List provision templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/provision_templates",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to list all [provision templates](https://support.zoom.us/hc/en-us/articles/360035817952) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_provision_templates:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-r"
},
{
"info": {
"name": "Add a provision template",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/provision_templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to [create a provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_8266cb40-58fc-4c1a-8da2-885d72167234) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:provision_template:admin`\n\n**[Rate Limit Label](http"
},
{
"info": {
"name": "Get a provision template",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/provision_templates/:templateId",
"params": [
{
"name": "templateId",
"value": "",
"type": "path",
"description": "The template ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to get a specific [provision template](https://support.zoom.us/hc/en-us/articles/360035817952).\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:provision_template:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limit"
},
{
"info": {
"name": "Update a provision template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/provision_templates/:templateId",
"params": [
{
"name": "templateId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to update a [provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:provision_template:admin`\n\n**[Rate Limit Label](htt"
},
{
"info": {
"name": "Delete a provision template",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/provision_templates/:templateId",
"params": [
{
"name": "templateId",
"value": "",
"type": "path",
"description": "The template ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to [delete a provision template](https://support.zoom.us/hc/en-us/articles/360035817952#h_7b34cd1d-5ae6-4a23-bd04-454a6ad8cb3e) in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:provision_template:admin`\n\n**[Rate Limit Label](htt"
}
]
},
{
"info": {
"name": "Recordings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a recording by call element ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_element/:callElementId/recording",
"params": [
{
"name": "callElementId",
"value": "",
"type": "path",
"description": "The ID of the call element."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's [call recording](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) by the call element's `callElementId`.\n**Prerequisites** \n* A Pro or higher account with Zoom Phone license \n* Account owner or admin privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/in"
},
{
"info": {
"name": "Get recording by call ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_logs/:id/recordings",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "This field gets the unique ID of the call log. You can use `callLogId` and `callId` as path parameters. You can find the value for this field with the **[Get account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs)** API or the **[Get user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)** API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's [call recording](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings) by the recording's `callId` or `callLogId`. \n\n**Note**: Returns the `file_url` in the JSON query results.\n\n**Prerequisites** \n* A Pro or higher account with Zoom Phone license \n* Account owner or admin privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`\n"
},
{
"info": {
"name": "Download a phone recording",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/recording/download/:fileId",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The file ID of the phone recording."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Downloads the phone recording. \n\n**Prerequisites:**\n\n* A Business or Enterprise account\n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-refer"
},
{
"info": {
"name": "Download a phone recording transcript",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/recording_transcript/download/:recordingId",
"params": [
{
"name": "recordingId",
"value": "",
"type": "path",
"description": "The phone recording ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Downloads the phone recording transcript. \n\n**Prerequisites**\n\n* A Business or Enterprise account\n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_recording:read`,`phone_recording:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:recording_transcript`,`phone:read:recording_transcript:admin`\n\n**[Rate Limit Label](https://marketplace."
},
{
"info": {
"name": "Get call recordings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/recordings",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call. \n\nThe default is **30** and the maximum is **300**."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of the returned records."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd T HH:mm:ssZ** format. \n\nThe date range defined in the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is **required** only when the `from` parameter is specified. \n\nThe end time and date display in **yyyy-mm-dd** or **yyyy-MM-dd T HH:mm:ssZ** format, which is the same format as the `from` parameter."
},
{
"name": "owner_type",
"value": "",
"type": "query",
"description": "The owner type. \n\nThe allowed values are `null`, `user`, `callQueue`, or `sharedOffice`(deprecated and to be replaced by `commonArea` after the transition period). \n\nThe default value is `null`. If the value is `null`, it returns all owner types."
},
{
"name": "recording_type",
"value": "",
"type": "query",
"description": "The recording type. The allowed values are `null`, `OnDemand`, or `Automatic`. The default value is `null`. If `null`, it returns all recording types."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site ID. \n\nThe default value is `All sites`."
},
{
"name": "query_date_type",
"value": "",
"type": "query",
"description": "The query date type, which can be `start_time` or `end_time`. \n\nThe default value is `start_time`."
},
{
"name": "group_id",
"value": "",
"type": "query",
"description": "The group ID. \n\nThe default value is `All groups`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings). \n\n**Prerequisites:** \n* A Pro or higher account plan \n * A Zoom Phone license \n * Account owner or admin privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_recording:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_rec"
},
{
"info": {
"name": "Update auto delete field",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/recordings/:recordingId",
"params": [
{
"name": "recordingId",
"value": "",
"type": "path",
"description": "The unique identifier of the recording."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the auto delete field for recording. It only updates if you enable the **Auto Delete Data After Retention Duration** setting in the account settings for recordings. \n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin`\n\n**[Granular Scopes](https://developer"
},
{
"info": {
"name": "Delete a call recording",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/recordings/:recordingId",
"params": [
{
"name": "recordingId",
"value": "",
"type": "path",
"description": "The unique identifier of the recording."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a call recording.\n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_recording`,`phone:delete:call_recording:admin`\n\n**[Rate Limit Label](https:"
},
{
"info": {
"name": "Update Recording Status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.zoom.us/v2/phone/recordings/:recordingId/status",
"params": [
{
"name": "recordingId",
"value": "",
"type": "path",
"description": "The recording ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the status of a single recording in account. \n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account. \n* User must have a Zoom Phone license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_recording:write`,`phone_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_recording`,`phone:update:call_recording:admin"
},
{
"info": {
"name": "Get user's recordings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/recordings",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through large result sets. 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."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a user's [Zoom Phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read:admin`,`phone_recording:read`"
}
]
},
{
"info": {
"name": "Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get call charges usage report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/reports/call_charges",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The from date should not exceed recent 13 months. If unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format is the same format as the `from` parameter."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records to be returned within a single API call. The default is **30** and the maximum is **300**."
},
{
"name": "next_page_token",
"value": "",
"type": "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.."
},
{
"name": "billing_account_id",
"value": "",
"type": "query",
"description": "The billing account ID."
},
{
"name": "show_charges_only",
"value": "",
"type": "query",
"description": "This field shows calls with charges only. The default value is `false`."
},
{
"name": "call_ids",
"value": "",
"type": "query",
"description": "The call IDs to filter the call charge report. The maximum limit is 100."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the Phone Call Charges Report. \n\nThe Call charges usage report allows account owners and admins to view monthly Zoom phone call charges. Account owners and admins can also access this information when they log into their Zoom accounts and navigate to [Call Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&chargeRestrict=0&by=1).\n\n **Prerequisites:** \n\n* Account must be enrollled in Pro or a higher plan\n* Account must be enroll"
},
{
"info": {
"name": "Get fax charges usage report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/reports/fax_charges",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The from date should not exceed recent 13 months. If unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format is the same format as the `from` parameter."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records to be returned within a single API call. The default is 30 and the maximum is 300."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "fax_id",
"value": "",
"type": "query",
"description": "The fax ID is used to filter the charge of a specific fax within the period."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the Phone Fax Charges Report. The fax charges usage report allows account owners and admins to view monthly Zoom phone fax charges. \n\nAccount owners and admins can also access this information when they log into their Zoom accounts and navigate to [Fax Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&by=3). \n\n**Prerequisites** \n* Account must be enrollled in Pro or a higher plan\n* Account must be enrolled in a [Zoom Phone](https:"
},
{
"info": {
"name": "Get operation logs report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/reports/operationlogs",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd**format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data within the 24 hours."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. The end time and date is in **yyyy-mm-dd** format; the same format as the `from` parameter."
},
{
"name": "category_type",
"value": "",
"type": "query",
"description": "This field filters the response by the category of the action performed. By default, the value of this field is "all" and thus, the response will include log of all operations for the defined period. \n \n To only include response for a specific category type, provide a value for `category_type` from this [table](https://marketplace.zoom.us/docs/api-reference/other-references/phone-operation-categories)."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"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."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the phone system operation logs report.\n\nThe phone system operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details. \n\n Account owners and admins can also access this information by logging into their Zoom accounts and navigating to [Phone System Operation Logs](https://zoom.us/pbx/page/report/operations#/report/operation-logs). \n \n **Prerequisites:** \n \n* Account must be enrollled in Pro or a higher plan\n* Account must be e"
},
{
"info": {
"name": "Get SMS/MMS charges usage report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/reports/sms_charges",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The from date should not exceed recent 13 months. If unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is **required** only when you specify the `from` parameter. End time and date is in a **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The `from` parameter uses the the same format."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records to be returned within a single API call. The default is **30**, and the maximum is **300**."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "show_charges_only",
"value": "",
"type": "query",
"description": "This field shows SMS/MMS with charges only. Defaults to false."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the **SMS/MMS Charges Report**. The **SMS/MMS charges usage report** allows account owners and admins to view monthly Zoom phone SMS charges. Account owners and admins can also access this information by when they log into their Zoom accounts and navigate to [ SMS/MMS Charges Usage Report](https://zoom.us/pbx/page/report/system#/report/phone-system/charge?page_size=15&chargeRestrict=0&by=2). **Prerequisites** * Account must be enrolled in Pro or a higher plan * Account must "
}
]
},
{
"info": {
"name": "Routing Rules",
"type": "folder"
},
"items": [
{
"info": {
"name": "List directory backup routing rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/routing_rules",
"params": [
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of directory backup routing rules. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN. **Prerequisites:** * A Business or Enterprise account * A Zoom Phone license\n\n**[Scopes](https://developers.z"
},
{
"info": {
"name": "Add directory backup routing rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/routing_rules",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a directory backup routing rule. \n\nThe directory backup routing rules are a series of predefined regular expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined external contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed through the PSTN.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.z"
},
{
"info": {
"name": "Get directory backup routing rule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/routing_rules/:routingRuleId",
"params": [
{
"name": "routingRuleId",
"value": "",
"type": "path",
"description": "The unique identifier of the routing rule."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the directory backup routing rule. The directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.**Prerequisites:** * A Business or Enterprise account * A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/d"
},
{
"info": {
"name": "Update directory backup routing rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/routing_rules/:routingRuleId",
"params": [
{
"name": "routingRuleId",
"value": "",
"type": "path",
"description": "The unique identifier of the routing rule."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the directory backup routing rule. \n\nThe directory backup routing rules are a series of predefined regular expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined external contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed through the PSTN.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers"
},
{
"info": {
"name": "Delete directory backup routing rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/routing_rules/:routingRuleId",
"params": [
{
"name": "routingRuleId",
"value": "",
"type": "path",
"description": "The unique identifier of the routing rule."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the directory backup routing rule. \n\nThe directory backup routing rules are a series of predefined Regular Expressions. These rules are used to route outgoing calls. If a dialed number does not match a Zoom Phone user, and does not match a defined External Contact, these rules are tested next. If a dialed number does not match any rules, the call will be routed via the PSTN.\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoo"
}
]
},
{
"info": {
"name": "SMS",
"type": "folder"
},
"items": [
{
"info": {
"name": "Post SMS message",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sms/messages",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Sends [SMS messages](https://support.zoom.us/hc/en-us/articles/360054631031-Setting-up-SMS) to Zoom Phone accounts. \n\n**Service Endpoint SMS**\n* This API now supports sending a Service Endpoint SMS or MMS message.\n* The sender phone number must be assigned to a Service Endpoint and enabled for SMS.\n* Non-Zoom Phone users can send only Service Endpoint SMS or MMS messages. An account-level app is required for non-Zoom Phone users to send Service Endpoint SMS.\n\n**Prerequisites**\n* A Zoom Phone lic"
},
{
"info": {
"name": "Get account's SMS sessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms/sessions",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of returned records."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is required only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "session_type",
"value": "",
"type": "query",
"description": "This field filters the session list by session type.\n\nThe value for this field can be one of the following:\n* `user`\n* `call_queue`\n* `auto_receptionist`\n* `service_endpoint`\n* `all`"
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "The sender's or receiver's phone number that limits the list of SMS sessions."
},
{
"name": "filter_type",
"value": "",
"type": "query",
"description": "This field filters by `sent_message_time`, `received_message_time`, `last_message_time`, or `sent_received_message_time` for the From and To timestamps.\n* `last_message_time`: queries which sessions last messages between From and To timestamps.\n* `sent_message_time`: queries which sessions have sent messages between From and To timestamps.\n* `received_message_time`: queries which sessions have received messages between From and To timestamps.\n* `sent_received_message_time`: queries which sessions have either sent or received messages between the From and To timestamps."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about SMS sessions for an account.\n\n---\n\n**Service Endpoint SMS**\n* This API now supports retrieving Service Endpoint SMS sessions.\n* Non-Zoom Phone users can access only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS.\n\n---\n\n**Prerequisites**\n* Paid account\n* Zoom Phone enabled for the account\n* For Zoom Phone SMS: a Zoom Phone-enabled user\n* For Service Endpoint SMS: an account-level app and a Service Endpo"
},
{
"info": {
"name": "Get SMS session details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms/sessions/:sessionId",
"params": [
{
"name": "sessionId",
"value": "",
"type": "path",
"description": "The SMS session ID."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of returned records."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "delivery_status",
"value": "",
"type": "query",
"description": "This field filters messages by `all`, `received`, `delivered`, `failed_to_send`, `sent`, `failed_to_deliver`, or `unknown` status.\n* `all`: searches for messages in any status. (Default)\n* `received`: queries messages that were successfully received on the Zoom number.\n* `delivered`: queries messages that were successfully delivered to the intended recipient(s) on the mobile operator's network.\n* `failed_to_send`: queries messages that could not be sent from the Zoom network to the mobile operator's network.\n* `sent`: queries messages that have been sent to the carrier but a delivery confirmation has not been received yet.\n* `failed_to_deliver`: queries messages that could not be delivered to the recipient.\n* `unknown`: queries messages where the system is unable to determine if the delivery was successful."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "The order of the SMS to return based on creation time. `1`: ascending `2`: descending"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about an SMS session.\n\n**Service Endpoint SMS**\n* This API now supports retrieving a Service Endpoint SMS session.\n* The `sessionId` must belong to a Service Endpoint SMS session.\n* Non-Zoom Phone users can access only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS.\n\n**Prerequisites**\n* A paid account\n* Zoom Phone enabled for the account\n* For Zoom Phone SMS: a Zoom Phone-enabled user\n* For Service Endpoint "
},
{
"info": {
"name": "Get SMS by message ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms/sessions/:sessionId/messages/:messageId",
"params": [
{
"name": "sessionId",
"value": "",
"type": "path",
"description": "The SMS session ID."
},
{
"name": "messageId",
"value": "",
"type": "path",
"description": "The SMS message ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about a specific message in an SMS session.\n\n**Service Endpoint SMS**\n* This API supports retrieving a specific message from a Service Endpoint SMS session.\n* The `sessionId` must belong to a Service Endpoint SMS session, and the `messageId` must belong to that session.\n* Non-Zoom Phone users can only access messages in Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS.\n\n**Prerequisites**\n* A paid account\n* Zoo"
},
{
"info": {
"name": "Sync SMS by session ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms/sessions/:sessionId/sync",
"params": [
{
"name": "sessionId",
"value": "",
"type": "path",
"description": "The SMS session ID."
},
{
"name": "sync_type",
"value": "",
"type": "query",
"description": "The options for synchronizing SMS message: \n \nFSync - Full sync \n \nISync - Increase sync \n \nBSync - Backward sync"
},
{
"name": "count",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "sync_token",
"value": "",
"type": "query",
"description": "The time range for returned records. It's used for locating where the next retrieval will begin."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Syncs SMS messages in a session. \n\n**Service Endpoint SMS**\n* This API now supports syncing a Service Endpoint SMS session.\n* The `sessionId` must belong to a Service Endpoint SMS session.\n* Non-Zoom Phone users can sync only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS.\n\n**Prerequisites**\n* Paid account\n* Zoom Phone enabled for the account\n* For Zoom Phone SMS: a Zoom Phone-enabled user\n* For Service Endpoint SMS: an acc"
},
{
"info": {
"name": "Get user's SMS sessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/sms/sessions",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID, user email, or “me” when using OAuth token."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The current page number of returned records."
},
{
"name": "session_type",
"value": "",
"type": "query",
"description": "This field filters the specific session list by a session type.\n\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is required only when the `from` parameter is specified. \n\nThe end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format is the same format as the `from` parameter."
},
{
"name": "phone_number",
"value": "",
"type": "query",
"description": "The sender's or receiver's phone number that limits the list of SMS sessions."
},
{
"name": "filter_type",
"value": "",
"type": "query",
"description": "This field filters by `sent_message_time`, `received_message_time`, `last_message_time`, or `sent_received_message_time` for the From and To timestamps.\n* `last_message_time`: queries which sessions last messages between From and To timestamps.\n* `sent_message_time`: queries which sessions have sent messages between From and To timestamps.\n* `received_message_time`: queries which sessions have received messages between From and To timestamps.\n* `sent_received_message_time`: queries which sessions have either sent or received messages between the From and To timestamps."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about SMS sessions for a user. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* Paid account \n* User-enabled Zoom phone\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-o"
},
{
"info": {
"name": "List user's SMS sessions in descending order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/sms/sessions/sync",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID, user email, or “me” when using OAuth token."
},
{
"name": "sync_type",
"value": "",
"type": "query",
"description": "FSync: Full sync BSync: Backward sync ISync: Forward sync"
},
{
"name": "sync_token",
"value": "",
"type": "query",
"description": "The sync token. Use if requesting a backward (`BSync`) or forward (`ISync`) sync."
},
{
"name": "count",
"value": "",
"type": "query",
"description": "The record count of each query"
},
{
"name": "session_type",
"value": "",
"type": "query",
"description": "This field filters the specific session list by a session type.\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the user's SMS sessions in descending order. Mirrors the ZP client behavior with the most recent on top.\n\n**Prerequisites:**\n* Paid account \n* User-enabled Zoom phone \n \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin`\n\n**[Rat"
}
]
},
{
"info": {
"name": "SMS Campaign",
"type": "folder"
},
"items": [
{
"info": {
"name": "List SMS campaigns",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms_campaigns",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of all SMS campaigns in a Zoom account.\n\n**Prerequisites** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sms_campaigns:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Get an SMS campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms_campaigns/:smsCampaignId",
"params": [
{
"name": "smsCampaignId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a specific SMS campaign.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Assign a phone number to SMS campaign",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sms_campaigns/:smsCampaignId/phone_numbers",
"params": [
{
"name": "smsCampaignId",
"value": "",
"type": "path",
"description": "The unique identifier of the campaign to which the phone number will be assigned."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Assigns a phone number to the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVQM1WMW5JD48YNY3J581B).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:sms_campaign"
},
{
"info": {
"name": "List opt statuses of phone numbers assigned to SMS campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms_campaigns/:smsCampaignId/phone_numbers/opt_status",
"params": [
{
"name": "smsCampaignId",
"value": "",
"type": "path",
"description": "The SMS campaign ID."
},
{
"name": "consumer_phone_number",
"value": "",
"type": "query",
"description": "The end user's phone number that sends the Opt-in or Opt-out keyword to the Zoom Phone number."
},
{
"name": "zoom_phone_user_numbers",
"value": "",
"type": "query",
"description": "The Zoom users' phone numbers that receive the Opt-in or Opt-out keyword from the end user."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the opt statuses of phone numbers that are assigned to SMS the campaign.\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:sms_campaign_number_opt_status:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update opt statuses of phone numbers assigned to SMS campaign",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/sms_campaigns/:smsCampaignId/phone_numbers/opt_status",
"params": [
{
"name": "smsCampaignId",
"value": "",
"type": "path",
"description": "The SMS campaign ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates opt statuses of phone numbers that are assigned to the SMS campaign.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:sms_campaign_number_opt_status:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Unassign a phone number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/sms_campaigns/:smsCampaignId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "smsCampaignId",
"value": "",
"type": "path"
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "Provide either phone number (in E164 format) or phoneNumberId of the campaign. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Unassigns a phone number from the SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVSPVM8MZN4Y9EW5690QHH).\nRemove the assigned phone number from the campaign.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The campaign must have been previously assigned a Zoom Phone number\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:writ"
},
{
"info": {
"name": "List user's opt statuses of phone numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/user/:userId/sms_campaigns/phone_numbers/opt_status",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID."
},
{
"name": "consumer_phone_numbers",
"value": "",
"type": "query",
"description": "The end user's phone number that sends the Opt-in or Opt-out keyword to the Zoom Phone number."
},
{
"name": "zoom_phone_user_numbers",
"value": "",
"type": "query",
"description": "The Zoom users' phone numbers that receive the Opt-in or Opt-out keyword from the end user."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the opt statuses of a user’s phone numbers. For user-level apps, pass the me value instead of the userId parameter.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign_number_opt_status`,`phone:read:sms_campaign_"
}
]
},
{
"info": {
"name": "SMS Consent",
"type": "folder"
},
"items": [
{
"info": {
"name": "List opt statuses of phone numbers assigned to SMS consent",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sms_consent/:consentId/phone_numbers/opt_status",
"params": [
{
"name": "consentId",
"value": "",
"type": "path",
"description": "The SMS consent ID."
},
{
"name": "consumer_phone_number",
"value": "",
"type": "query",
"description": "The end user's phone number that sends the Opt-in or Opt-out keyword to the Zoom Phone number."
},
{
"name": "zoom_phone_user_numbers",
"value": "",
"type": "query",
"description": "The Zoom users' phone numbers that receive the Opt-in or Opt-out keyword from the end user."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the opt statuses of phone numbers that are assigned to SMS consent.\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:sms_consent_number_opt_status:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
}
]
},
{
"info": {
"name": "Setting Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "List setting templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/setting_templates",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Number of records returns within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Unique identifier of the site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) for details. If this is not provided, the response lists the account level setting templates."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a list of all the created phone template settings.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_setting_templates:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Add a setting template",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/setting_templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a Zoom Phone setting template for an account. After creating a phone template, the defined settings will become the default settings for an account.\n\n**Prerequisites:** \n* A Business or enterprise Zoom account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:setting_template:admin`\n\n**[Rate Limit Label](ht"
},
{
"info": {
"name": "Get setting template details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/setting_templates/:templateId",
"params": [
{
"name": "templateId",
"value": "",
"type": "path",
"description": "The unique identifier of the template."
},
{
"name": "custom_query_fields",
"value": "",
"type": "query",
"description": "This field provides the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {“description”: “template description”}."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information about an account's phone template.\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:setting_template:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Update a setting template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/setting_templates/:templateId",
"params": [
{
"name": "templateId",
"value": "",
"type": "path",
"description": "The Template ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates or modifies a phone template's settings.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:setting_template:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
}
]
},
{
"info": {
"name": "Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get account policy details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/policies/:policyType",
"params": [
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field specifies the type of policy to retrieve or modify. See the documentation for detailed behavior of each policy type.\n\nSupported values:\n- `allow_emergency_calls`: Controls whether emergency calls are allowed."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the account policy details.\n\n**Prerequisites**\n* Pro or higher account plan with 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:policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Update account policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/policies/:policyType",
"params": [
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field epecifies the type of policy to retrieve or modify. See the documentation for detailed behavior of each policy type.\n\nSupported values:\n- `allow_emergency_calls`: Controls whether emergency calls are allowed."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the account's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) policy.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rat"
},
{
"info": {
"name": "List ported numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/ported_numbers/orders",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to list ported numbers in a Zoom account.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_peering:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_ported_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Get ported numbers details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/ported_numbers/orders/:orderId",
"params": [
{
"name": "orderId",
"value": "",
"type": "path",
"description": "Order ID of the ported numbers. This can be retrieved from the List Ported Numbers API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details on the ported numbers by specifying `order_id`.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_peering:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:ported_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Get phone account settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/settings",
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an account's settings.\n\n**Prerequisites:**\n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:settings:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
{
"info": {
"name": "Update phone account settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/settings",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates Zoom Phone [account settings](https://support.zoom.us/hc/en-us/articles/360025846692).\n\n**Prerequisites:** \n* A Business or Enterprise account\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:settings:admin`"
},
{
"info": {
"name": "List SIP groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sip_groups",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of SIP (Session Initiation Protocol) groups.\n\n**Prerequisites:** \n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\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_sip_groups:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIG"
},
{
"info": {
"name": "List BYOC SIP trunks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sip_trunk/trunks",
"params": [
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of an account's assigned [BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf).\n\n**Prerequisites** \n* A Business or Enterprise account\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_sip_trunks:admin`\n\n**[Rate Limit Label](https://market"
}
]
},
{
"info": {
"name": "Shared Line Appearance",
"type": "folder"
},
"items": [
{
"info": {
"name": "List shared line appearances",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/shared_line_appearances",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of [shared line appearance](https://support.zoom.us/hc/en-us/articles/4406753208461-Enabling-or-disabling-shared-lines-privacy-mode) instances.\n\n**Prerequisites** \n* Pro or higher account with Zoom Phone license \n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_shared_line_appeara"
}
]
},
{
"info": {
"name": "Shared Line Group",
"type": "folder"
},
"items": [
{
"info": {
"name": "List shared line groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/shared_line_groups",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Lists all the shared line groups. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This capability gives members of the shared line group access to the group's direct phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integ"
},
{
"info": {
"name": "Create a shared line group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/shared_line_groups",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overvie"
},
{
"info": {
"name": "Get a shared line group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the shared line group."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": " Returns a list of all the shared line groups. \n \n A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/inte"
},
{
"info": {
"name": "Get shared line group call handling setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/call_handling/settings",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "hour_type",
"value": "",
"type": "query",
"description": "The hour type of the call handling setting. Defaults to `business_hours` if not provided."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `hour_type` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `hour_type` is `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call handling setting of a shared line group for the specified hour type.\n\n**Prerequisites:**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\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:shared_line_group_call_handling_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.u"
},
{
"info": {
"name": "Update shared line group call handling setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/call_handling/settings/:hourType",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the call handling setting of a shared line group for the specified hour type.\n\nAt least one of `call_distribution_setting` or `call_handling_setting` must be provided in the request body. `call_distribution_setting` is only allowed when `hour_type` is `business_hour`.\n\n**Prerequisites:**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granu"
},
{
"info": {
"name": "Get a shared line group policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/policies",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the shared line group."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the policy setting of a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792).\n\n**Prerequisites:**\n* Pro or a higher account with Zoom Phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:shared_line_group_policy:admin`\n\n**[Rate Limit Label](https://mar"
},
{
"info": {
"name": "Update a shared line group policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/policies",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The unique identifier of the shared line group."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the policy setting of a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792). \n\n**Prerequisites:**\n* Pro or higher account plan with Zoom Phone License\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:shared_line_group_policy:admin`\n\n**[Rate Limit Label](http"
},
{
"info": {
"name": "Get shared line group settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/settings",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "setting_type",
"value": "",
"type": "query",
"description": "The setting item to query. Defaults to `business_hours` if not provided. Allowed values: `holiday_hours`, `business_hours`, `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns shared line group settings.\n\n**Prerequisites:**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:shared_line_group_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
},
{
"info": {
"name": "Add shared line group setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/settings/:settingType",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item you want to add. Allowed values: `holiday_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the shared line group setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:shared_line_group_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limit"
},
{
"info": {
"name": "Update shared line group setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/settings/:settingType",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item you want to modify. Allowed values: `holiday_hours`, `business_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the shared line group setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:shared_line_group_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-li"
},
{
"info": {
"name": "Delete shared line group setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:sharedLineGroupId/settings/:settingType",
"params": [
{
"name": "sharedLineGroupId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type to delete. Allowed values: `holiday_hours`, `break_hours`."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `settingType` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `settingType` is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the shared line group setting according to the setting type.\n\n**Prerequisites**\n* A Pro or higher account with a Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:shared_line_group_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-l"
},
{
"info": {
"name": "Update a shared line group",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": " Updates the information about a shared line group. \n \n A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. Members of the shared line group can access to the group's direct phone number and voicemail. \n\n**Prerequisites** \n \n* Pro or higher account with Zoom Phone license\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integra"
},
{
"info": {
"name": "Delete a shared line group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. \n\n**Prerequisites:** \n * Pro or higher account with Zoom Phone license.\n * Account owner or admin privileges \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oau"
},
{
"info": {
"name": "Add members to a shared line group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/members",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Adds members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca) to a shared line group. A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common areas. This gives members of the shared line group access to the group's direct phone number and voicemail. Note that a member can only be added to one shar"
},
{
"info": {
"name": "Unassign members from a shared line group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/members",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns **all** existing members from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. \n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/doc"
},
{
"info": {
"name": "Unassign a member from a shared line group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/members/:memberId",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The unique identifier of the shared line group from which you would like to remove a member."
},
{
"name": "memberId",
"value": "",
"type": "path",
"description": "The unique identifier of the member who is to be removed."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns **a specific member** from a shared line group. Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. \n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/doc"
},
{
"info": {
"name": "Assign phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/phone_numbers",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns phone numbers to a shared line groups. These direct phone numbers will be shared among members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n * Pro or higher account with Zoom Phone license.\n * A valid Shared Line Group\n * Account owner or admin privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers."
},
{
"info": {
"name": "Unassign all phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/phone_numbers",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns all the phone numbers that have been assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n\n* Pro or higher account with Zoom Phone license.\n* A valid Shared Line Group\n* Account owner or admin privileges\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/)"
},
{
"info": {
"name": "Unassign a phone number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "slgId",
"value": "",
"type": "path"
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "The unique identifier of the phone number which is to be unassigned. This can be retrieved from Get a Shared Line Group API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns a specific phone number that was assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).\n\n**Prerequisites:** \n \n* Pro or higher account with Zoom Phone license.\n* A valid shared line group\n* Account owner or admin privileges\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):"
},
{
"info": {
"name": "Add a policy setting to a shared line group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/policies/:policyType",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The slg ID."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This setting corresponds to tbe policy item you wish to add. Allowed values: `voice_mail`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to set up shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-sco"
},
{
"info": {
"name": "Update an SLG policy setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/policies/:policyType",
"params": [
{
"name": "slgId",
"value": "",
"type": "path"
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This setting corresponds to tbe policy item you wish to update. Allowed values: `voice_mail`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to update shared access members. \n\n**Prerequisites:** \n* Pro or higher account with Zoom Phone license.\n* Account owner or admin privileges \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/"
},
{
"info": {
"name": "Delete an SLG policy setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/shared_line_groups/:slgId/policies/:policyType",
"params": [
{
"name": "slgId",
"value": "",
"type": "path",
"description": "The shared line group ID."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This setting corresponds to tbe policy item you wish to remove. Allowed values: `voice_mail`."
},
{
"name": "shared_ids",
"value": "",
"type": "query",
"description": "The comma separated list of shared IDs to remove. The number is limited to the minimum value of 10 or the number of allowed access members account setting."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the policy sub-setting for a specific [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) according to the `policyType`. For example, you can use this API to remove shared access members. **Prerequisites:** * Pro or higher account with Zoom Phone license.* Account owner or admin privileges \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-"
}
]
},
{
"info": {
"name": "Sites",
"type": "folder"
},
"items": [
{
"info": {
"name": "List phone sites",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"name": "site_name",
"value": "",
"type": "query",
"description": "The name of the site you want to search."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the [sites](https://support.zoom.us/hc/en-us/articles/360020809672) that have been created for an account. \n \n**Prerequisites:** \n \n* Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n* Pro or a higher account with Zoom Phone enabled.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-sc"
},
{
"info": {
"name": "Create a phone site",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sites",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a [site](https://support.zoom.us/hc/en-us/articles/360020809672) that allows you to organize the Zoom Phone users in your organization.\n\n**Prerequisites:**\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n* Pro or a higher account with Zoom Phone enabled.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](ht"
},
{
"info": {
"name": "Get phone site details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites/:siteId",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The unique identifier of the site."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns information on a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). \n\nSites allow you to organize Zoom Phone users in your organization. \n\n**Prerequisites** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `ph"
},
{
"info": {
"name": "Update phone site details",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/sites/:siteId",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The unique identifier of the site."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672). \n\nIt allows you to organize Zoom Phone users in your organization. \n\n\n**Prerequisites** \nAn account must have a Pro or a higher plan with Zoom Phone license.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:site:admin`\n\n**[Rate Limit La"
},
{
"info": {
"name": "Delete a phone site",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/sites/:siteId",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The unique identifier of the site."
},
{
"name": "transfer_site_id",
"value": "",
"type": "query",
"description": "The site ID of another site where the assets of the current site (users, numbers and phones) can be transferred."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": " Use this API to delete a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) in a Zoom account. To delete a site, in the query parameter, you must provide the site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site.\n\n**Prerequisites:** \n\n* Account must have a Pro or a higher plan with Zoom Phone license. \n* [Multiple sites](https://support.zoom.us/hc/en-us/articles/3600208096"
},
{
"info": {
"name": "List customized outbound caller ID phone numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_caller_id/customized_numbers",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
},
{
"name": "selected",
"value": "",
"type": "query",
"description": "Status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "For filtering phone numbers that belong to the site."
},
{
"name": "extension_type",
"value": "",
"type": "query",
"description": "The type of the extension to which the phone number belongs."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "A search keyword for phone or extension numbers."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to retrieve phone numbers that can be used as the `site-level` customized outbound caller ID. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/do"
},
{
"info": {
"name": "Add customized outbound caller ID phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_caller_id/customized_numbers",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to add the `site-level` customized outbound caller ID phone numbers. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-sc"
},
{
"info": {
"name": "Remove customized outbound caller ID phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/outbound_caller_id/customized_numbers",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
},
{
"name": "customize_ids",
"value": "",
"type": "query",
"description": "The customization IDs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove the `site-level` customized outbound caller ID phone numbers. \n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15). \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth"
},
{
"info": {
"name": "Get a phone site setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/settings/:settingType",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The site setting type: \n* `local_based_routing` \n* `business_hours` \n* `closed_hours` \n* `holiday_hours` \n* `security` \n* `outbound_caller_id` \n* `audio_prompt` \n* `desk_phone` \n* `dial_by_name` \n* `billing_account`"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": " Gets the site setting about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type. Sites allow you to organize Zoom Phone users in your organization.\n\n**Prerequisites:** \n\n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrat"
},
{
"info": {
"name": "Add a site setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/settings/:settingType",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The site setting type: \n* `holiday_hours` \n* `security`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Sites allow you to organize Zoom Phone users in your organization. Use this API to add a site setting to a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/"
},
{
"info": {
"name": "Update the site setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/settings/:settingType",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The site setting type: \n* `local_based_routing` \n* `business_hours` \n* `closed_hours` \n* `holiday_hours`\n* `outbound_caller_id` \n* `audio_prompt` \n* `desk_phone` \n* `dial_by_name` \n* `billing_account`"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Allows you to organize Zoom Phone users in your organization. You can update the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) according to the setting type.\n\n**Prerequisites** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrati"
},
{
"info": {
"name": "Delete a site setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/sites/:siteId/settings/:settingType",
"params": [
{
"name": "siteId",
"value": "",
"type": "path",
"description": "The site ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The site setting type: \n* `holiday_hours` \n* `security`."
},
{
"name": "device_type",
"value": "",
"type": "query",
"description": "The device type. Enable SRTP AES-256 encryption on the site for the specified device type. Used for `security` setting type."
},
{
"name": "holiday_id",
"value": "",
"type": "query",
"description": "The holiday hour setting ID. Used for `holiday_hours` setting type."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Sites allow you to organize Zoom Phone users in your organization. Use this API to delete the site setting of a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672).\n\n**Prerequisites:** \n* Account must have a Pro or a higher plan with Zoom Phone license.\n* Multiple sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes"
}
]
},
{
"info": {
"name": "Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "List phone users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API."
},
{
"name": "calling_type",
"value": "",
"type": "query",
"description": " The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of calling plan."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of the Zoom Phone user. \n\n `pending`: The users have been assigned the Zoom Workplace license, but not been assigned Zoom Phone feature."
},
{
"name": "department",
"value": "",
"type": "query",
"description": "The department where the user belongs."
},
{
"name": "cost_center",
"value": "",
"type": "query",
"description": "The cost center where the user belongs."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The partial string of user's name, extension number, or phone number."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of all of an account's users who are assigned a Zoom Phone license.\n\n**Prerequisites** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_users:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Batch add users",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/batch",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds phone users in batch. You can add up to 10 users at a time.\n\n**Prerequisites**\n* The users must be active in your [Zoom account](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#tag/Users/operation/users). \n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scope"
},
{
"info": {
"name": "Update multiple users' properties in batch",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.zoom.us/v2/phone/users/batch",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates multiple users' properties in batch. For example, you can update the users' [site](https://support.zoom.us/hc/en-us/articles/360020809672) when `batchType` is equal to `move_site`. You can update 10 users at a time. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):**"
},
{
"info": {
"name": "Get a user's profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read:admin`\n\n**[Granula"
},
{
"info": {
"name": "Update a user's profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a user's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo add, update or remove the shared access members for voicemail and call recordings, use the [Add](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Users/operation/addUserSetting)/[Update](https://marketplace.zoom.us/docs/"
},
{
"info": {
"name": "Add user call forward setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_forward_settings/:hourType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds Zoom Phone call forwarding numbers for a user under a specific hour type. Call forwarding settings let users route their inbound calls to one or more external phone numbers or external contacts during business, closed, holiday, or break hours.\n\n**Prerequisites:**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/in"
},
{
"info": {
"name": "Delete user call forward setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_forward_settings/:hourType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass the `me` value for the `userId` parameter."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. The `closed_hours` and `break_hours` values cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
},
{
"name": "call_forward_id",
"value": "",
"type": "query",
"description": "The call forwarding ID."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete Zoom Phone call forwarding numbers for a user under a specific hour type. Call forwarding settings let users route their inbound calls to one or more external phone numbers or external contacts during business, closed, holiday, or break hours.\n\n**Prerequisites:**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs"
},
{
"info": {
"name": "Get user call handling setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_handling/settings",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "hour_type",
"value": "",
"type": "query",
"description": "The hour type of the call handling setting."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `hour_type` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `hour_type` is `break_hours`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the call handling setting of a user for the specified hour type.\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`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_call_handling_setting:admin`,`phone:read:user_call_handling_setting`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs"
},
{
"info": {
"name": "Update user call handling setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_handling/settings/:hourType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "hourType",
"value": "",
"type": "path",
"description": "The hour type of the call handling setting. `closed_hours` and `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a user's call handling settings for the specified hour type.\n\n**Prerequisites**\n* A Business or Enterprise account\n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_call_handling_setting:admin`,`phone:update:user_call_handling_setting`\n\n**[Rate Limit Label](https://marketplace.zoom.us/doc"
},
{
"info": {
"name": "Assign calling plan to a user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/calling_plans",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integration"
},
{
"info": {
"name": "Update user's calling plan",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.zoom.us/v2/phone/users/:userId/calling_plans",
"params": [
{
"name": "userId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Switches the [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/inte"
},
{
"info": {
"name": "Unassign user's calling plan",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/calling_plans/:planType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The ID of the user."
},
{
"name": "planType",
"value": "",
"type": "path",
"description": "The type of plan. Refer to the [Plan Number section](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans)."
},
{
"name": "billing_account_id",
"value": "",
"type": "query",
"description": "The billing account ID. If the user is located in India, the parameter is required."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user's [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-sco"
},
{
"info": {
"name": "List users' phone numbers for a customized outbound caller ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_caller_id/customized_numbers",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The unique identifier of the user."
},
{
"name": "selected",
"value": "",
"type": "query",
"description": "The status of the phone numbers. \n `true`- Numbers already added to the custom list. \n `false`- Numbers not yet added to the custom list"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "This field filters phone numbers that belong to the site."
},
{
"name": "extension_type",
"value": "",
"type": "query",
"description": "The type of extension where the phone number belongs."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "A search keyword for phone or extension numbers."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves phone numbers that can be the `user-level` customized outbound caller ID. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_user_customized_number`,`phone:read:list_user_customized_number:admin`\n\n**[Rate Limit Label](https://marke"
},
{
"info": {
"name": "Add phone numbers for users' customized outbound caller ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_caller_id/customized_numbers",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The unique identifier of the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds users' customized outbound caller ID phone numbers. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_customized_number`,`phone:write:user_customized_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference"
},
{
"info": {
"name": "Remove users' customized outbound caller ID phone numbers",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/outbound_caller_id/customized_numbers",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The unique identifier of the user."
},
{
"name": "customize_ids",
"value": "",
"type": "query",
"description": "The customization IDs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the users' customized outbound caller ID phone numbers. \n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_customized_number`,`phone:delete:user_customized_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-"
},
{
"info": {
"name": "Get user policy details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/policies/:policyType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field specifies the type of policy to retrieve or modify. See the documentation for detailed behavior of each policy type.\n- `allow_emergency_calls`: Controls whether emergency calls are allowed."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the user policy details.\n\n**Prerequisites**\n* Pro or higher account plan with Zoom phone license\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
},
{
"info": {
"name": "Update user policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId/policies/:policyType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID."
},
{
"name": "policyType",
"value": "",
"type": "path",
"description": "This field specifies the type of policy to retrieve or modify. See the documentation for detailed behavior of each policy type.\n- `allow_emergency_calls`: Controls whether emergency calls are allowed."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a user's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) policy.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:user_policy:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rat"
},
{
"info": {
"name": "Add a user's profile setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/profile_settings/:settingType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type that corresponds to the setting item you want to add. Allowed values: `holiday_hours`, `break_hours`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the user setting according to the setting type.\n\n**Prerequisites**\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:user_setting:admin`,`phone:write:user_setting`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-referen"
},
{
"info": {
"name": "Delete a user's profile profile setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/profile_settings/:settingType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or extension ID."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "The setting type to delete. Allowed values: `holiday_hours`, `break_hours`."
},
{
"name": "holiday_hour_id",
"value": "",
"type": "query",
"description": "The holiday hour ID. Required when `settingType` is `holiday_hours`."
},
{
"name": "break_hour_id",
"value": "",
"type": "query",
"description": "The break hour ID. Required when `settingType` is `break_hours`. **Note:** `break_hours` cannot be updated when business hours are set to `24 Hours a Day, 7 Days a Week`."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a user setting based on the setting type.\n\n**Prerequisites**\n* Pro or higher account with Zoom Phone license.\n* Account owner or admin permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:user_setting`,`phone:delete:user_setting:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/"
},
{
"info": {
"name": "Get a user's profile settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/settings",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the Zoom Phone [profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings) of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read:admin`\n\n**[Granular Scopes](ht"
},
{
"info": {
"name": "Update a user's profile settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId/settings",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the Zoom Phone [profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings) of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`\n\n**[Granular Scopes]("
},
{
"info": {
"name": "Add a user's shared access setting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/users/:userId/settings/:settingType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The unique identifier of the user."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "This field corresponds to the setting item you wish to modify. Allowed values: `voice_mail`, `delegation`, `desk_phone`, `intercom`, `auto_call_recording`,`ad_hoc_call_recording`"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail, and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Choose **Users** and select **User Policy**. Go to **Voicemail, Automatic "
},
{
"info": {
"name": "Update a user's shared access setting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/users/:userId/settings/:settingType",
"params": [
{
"name": "settingType",
"value": "",
"type": "path",
"description": "This field corresponds to the setting item you wish to modify. Allowed values: `voice_mail`, `delegation`, `desk_phone`, `intercom`, `auto_call_recording`,`ad_hoc_call_recording`"
},
{
"name": "userId",
"value": "",
"type": "path",
"description": "The unique identifier of the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Choose **Users** and select **User Policy**. Go to **Voicemail, Automati"
},
{
"info": {
"name": "Delete a user's shared access setting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/users/:userId/settings/:settingType",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The unique identifier of the user."
},
{
"name": "settingType",
"value": "",
"type": "path",
"description": "Corresponds to the setting item you wish to remove. Allowed values: `voice_mail`, `delegation`, `desk_phone`, `intercom`, `auto_call_recording`,`ad_hoc_call_recording`"
},
{
"name": "shared_id",
"value": "",
"type": "query",
"description": "This field is required only for voicemail, auto_call_recording, and ad_hoc_call_recording setting type."
},
{
"name": "assistant_extension_id",
"value": "",
"type": "query",
"description": "This field deletes the delegation assistant, used for delegation setting type."
},
{
"name": "device_id",
"value": "",
"type": "query",
"description": "This field deletes the assigned device, used for `desk_phone` setting type."
},
{
"name": "intercom_extension_id",
"value": "",
"type": "query",
"description": "This field deletes the intercom connection for the `intercom` setting type."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the user setting according to the setting type, specifically for delegation, intercom and shared access for voicemail and call recordings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nTo see the shared access settings in the Zoom web portal, go to **Admin > Phone System Management > Users & Rooms** . Click **Users** and select **User Policy**. Go to **Voicemail, Automatic"
}
]
},
{
"info": {
"name": "Voicemails",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a voicemail by call element ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/call_element/:callElementId/voice_mail",
"params": [
{
"name": "callElementId",
"value": "",
"type": "path",
"description": "The ID of the call element."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the detailed information on a voicemail by the call element's `callElementId`.\n**Prerequisites** \n* A Pro or higher account with Zoom Phone license \n* Account owner or admin privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail`,`phone:read:voicemail:a"
},
{
"info": {
"name": "Get user voicemail details from a call log",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/call_logs/:id/voice_mail",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The unique ID of the call log. You can use `callLogId` or `callId` as path parameters.\n\nYou can find the value for this field with in **[Get account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs)** API or **[Get user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs)** API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the detailed information on a voicemail associated with a call log ID. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicema"
},
{
"info": {
"name": "Get user's voicemails",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/users/:userId/voice_mails",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "The user ID or email address of the user. For user-level apps, pass `me` as the value for userId."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of the voice mail."
},
{
"name": "next_page_token",
"value": "",
"type": "query",
"description": "The next page token paginates through large result sets. 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."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "trash",
"value": "",
"type": "query",
"description": "Whether to query voicemails from trash."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a user's Zoom Phone voicemails. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\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`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrat"
},
{
"info": {
"name": "Get account voicemails",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/voice_mails",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned within a single API call."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of the voice mail."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site ID."
},
{
"name": "owner_type",
"value": "",
"type": "query",
"description": "The owner type. \n\nThe allowed values are `null`, `user`, `callQueue`, `sharedLineGroup`, `autoReceptionist`, or `sharedOffice`(deprecated and to be replaced by `commonArea` after the transition period). \n\nThe default value is `null`. If the value is `null`, it returns all owner types."
},
{
"name": "voicemail_type",
"value": "",
"type": "query",
"description": "The voicemail type."
},
{
"name": "next_page_token",
"value": "",
"type": "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.."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined in the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nThe month defined should fall within the last six months. If unspecified, it returns data from the past 30 days."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "This field is **required** only when the `from` parameter is specified. \n\nThe end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
},
{
"name": "trashed",
"value": "",
"type": "query",
"description": "Whether to query voicemails from trash. The default setting is false."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a user's Zoom Phone voicemails. \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`,`phone_voicemail:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_voicemails:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`"
},
{
"info": {
"name": "Download a phone voicemail",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/voice_mails/download/:fileId",
"params": [
{
"name": "fileId",
"value": "",
"type": "path",
"description": "The file ID of the phone voicemail."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Downloads the Zoom phone voicemail. \n\n**Prerequisites:**\n\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`,`phone:read:admin`,`phone_voicemail:read`,`phone_voicemail:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:admin`,`phone:read:voicemail`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/ra"
},
{
"info": {
"name": "Get voicemail details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/voice_mails/:voicemailId",
"params": [
{
"name": "voicemailId",
"value": "",
"type": "path",
"description": "The unique identifier of the voicemail. It retrieves the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/phoneUserVoiceMails) API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the information about a [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages). \n\n**Prerequisites** \n* Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_voicemail:read:admin`,`phone_voicemail:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail`,`phone:read:voicemail:admin`\n\n**[Rate"
},
{
"info": {
"name": "Update Voicemail Read Status",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/voice_mails/:voicemailId",
"params": [
{
"name": "voicemailId",
"value": "",
"type": "path",
"description": "The unique identifier of the voicemail. It retrieves the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/phone/methods/#operation/phoneUserVoiceMails) API."
},
{
"name": "read_status",
"value": "",
"type": "query",
"description": "The voicemail status. The `Unread` feature must enable **Mark Voicemail as Unread**."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates the status of [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages).\n\n**Prerequisites:**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_voicemail:write`,`phone_voicemail:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:voicemail`,`ph"
},
{
"info": {
"name": "Delete a voicemail",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/voice_mails/:voicemailId",
"params": [
{
"name": "voicemailId",
"value": "",
"type": "path",
"description": "The unique identifier of the voicemail. It retrieves the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserVoiceMails) API."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes an account's [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages).\n\n**Prerequisites:** \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_voicemail:write`,`phone_voicemail:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:voicemail`,`phone:delete:voicemail:admin`\n\n**[Rate "
}
]
},
{
"info": {
"name": "Zoom Rooms",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Zoom Rooms under Zoom Phone license",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/rooms",
"params": [
{
"name": "page_size",
"value": "",
"type": "query",
"description": "The number of records returned from a single API call."
},
{
"name": "next_page_token",
"value": "",
"type": "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."
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "The site ID retrievable from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API."
},
{
"name": "calling_type",
"value": "",
"type": "query",
"description": "The type of calling plan."
},
{
"name": "keyword",
"value": "",
"type": "query",
"description": "The Zoom room name or phone number from which to filter the results ."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves a list of [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) under the account that has the Zoom Phone license assigned.**Prerequisites:** * A Pro or higher account plan * A Zoom Phone license\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_rooms:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/doc"
},
{
"info": {
"name": "Add a Zoom Room to a Zoom Phone",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/rooms",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Associates a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a Zoom Phone license. \n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/d"
},
{
"info": {
"name": "List Zoom Rooms without Zoom Phone assignment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/rooms/unassigned",
"params": [
{
"name": "keyword",
"value": "",
"type": "query",
"description": "A search keyword for Zoom Room's name."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/360025153711) that are not assigned a Zoom Phone.**Prerequisites:** * A Pro or higher account plan * A Zoom Phone license\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_rooms:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-lim"
},
{
"info": {
"name": "Get a Zoom Room under Zoom Phone license",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId",
"params": [
{
"name": "roomId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Specifies [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account with an assigned Zoom Phone license.\n\n**Prerequisites** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-l"
},
{
"info": {
"name": "Update a Zoom Room under Zoom Phone license",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId",
"params": [
{
"name": "roomId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to update a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711) in an account that has the Zoom Phone license assigned.\n\n**Prerequisites:** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:room:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/do"
},
{
"info": {
"name": "Remove a Zoom Room from a ZP account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId",
"params": [
{
"name": "roomId",
"value": "",
"type": "path"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to remove [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037) from a Zoom Phone account.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:room:admin`\n\n**[Rate Limit Label](https://marketplac"
},
{
"info": {
"name": "Assign calling plans to a Zoom Room",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId/calling_plans",
"params": [
{
"name": "roomId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_70c74c57-50d6-406b-a4fa-2f33d4bebdbc) with a maximum of 200 numbers at a time.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom"
},
{
"info": {
"name": "Remove a calling plan from a Zoom Room",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId/calling_plans/:type",
"params": [
{
"name": "roomId",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "path",
"description": "The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to the Zoom Room. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)\n"
},
{
"name": "billing_account_id",
"value": "",
"type": "query",
"description": "The billing account ID. If the zoom room is located in India, the parameter is required."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to unassign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integratio"
},
{
"info": {
"name": "Assign phone numbers to a Zoom Room",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId/phone_numbers",
"params": [
{
"name": "roomId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "[Assigns phone numbers to a Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711). Up to 200 numbers at a time.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:room_phone_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-r"
},
{
"info": {
"name": "Remove a phone number from a Zoom Room",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.zoom.us/v2/phone/rooms/:roomId/phone_numbers/:phoneNumberId",
"params": [
{
"name": "roomId",
"value": "",
"type": "path",
"description": "Provide roomId of the Zoom Room."
},
{
"name": "phoneNumberId",
"value": "",
"type": "path",
"description": "Provide phoneNumberId of the Zoom Room. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "/",
"accessTokenUrl": "",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Use this API to unassign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6) from a [Zoom Room](https://support.zoom.us/hc/en-us/articles/360025153711#h_140e30ba-5a88-40b9-b799-16883fa0a037).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* The Zoom Room must have been previously assigned a Zoom Phone number\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-ove"
}
]
}
],
"bundled": true
}