{
  "opencollection": "1.0.0",
  "info": {
    "name": "Number Management",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "Cloud Peering Provider Exchange",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List peering phone numbers for provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/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 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 phone number the partner provides in [E.164](https://en.wikipedia.org/wiki/E.164\n) format.\n\n\n*  If this parameter is not specified, API will return all the phone numbers from the partner. "
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns phone numbers the carrier pushes to different customers.\n\n**Prerequisites** \n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom.\n* Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](h"
        },
        {
          "info": {
            "name": "List peering phone numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/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": "The phone number the partner provides in [E.164](https://en.wikipedia.org/wiki/E.164\n) format.\n\n\n*  If this parameter is not specified, API will return all the phone numbers previously assigned to the Zoom customer account by the partner. "
              },
              {
                "name": "carrier_code",
                "value": "",
                "type": "query",
                "description": "A unique code that Zoom provides to the partner at the time of establishing cloud peering infrastructure. This unique code is also tied to the developer `client ID` included as part of the token\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 the details associated with a specific phone number, or all the phone numbers the partner previously provisioned for the Zoom customer account.\n\n**Prerequisites:** \n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom.\n* Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. \n\n**[Scopes](https://developers.zoom.us/docs/integrations"
        },
        {
          "info": {
            "name": "Add peering phone numbers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zoom.us/v2/number_management/peering_numbers",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Enables provider exchange partners to add phone numbers to a Zoom account.\n\n**Prerequisites**\n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom.\n* Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular"
        },
        {
          "info": {
            "name": "Update peering phone numbers",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.zoom.us/v2/number_management/peering_numbers",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allows partners to update the status or details associated with the phone numbers.\n\n**Prerequisites** \n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom.\n* Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n"
        },
        {
          "info": {
            "name": "Remove peering phone numbers",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.zoom.us/v2/number_management/peering_numbers",
            "params": [
              {
                "name": "carrier_code",
                "value": "",
                "type": "query",
                "description": "\nThis is unique code that Zoom provides to the partner at the time of establishing cloud peering infrastructure. This unique code is also tied to the developer `client ID` included as part of the token\n\nThis 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 phone number the partner provides in [E.164](https://en.wikipedia.org/wiki/E.164\n) format.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Removes the phone number from the Zoom customer account. \n\nPartners can remove only the phone numbers they have previously added to Zoom account.\n\n**Prerequisites:** \n* [Enable Number Management](https://zoom.us/cpw/page/phoneNumbers#/number-list)\n* Developer is a provider exchange partner, with the cloud peering infrastructure established with Zoom.\n* Zoom account needs to have a Zoom Phone license or a Zoom Contact Center license. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth"
        }
      ]
    },
    {
      "info": {
        "name": "Phone Numbers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Allocate/Unallocate phone numbers",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.zoom.us/v2/number_management/allocation",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allocates or unallocates phone numbers for those with CPL routing.\n\n<p>Note: When allocating phone numbers, if there are any native numbers, they must belong to the same country or region, and have the same number plan.</p>\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:numbers:admin`\n\n**[Rate Limit Labe"
        },
        {
          "info": {
            "name": "Add BYOC phone numbers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zoom.us/v2/number_management/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/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:byoc_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** "
        },
        {
          "info": {
            "name": "List phone numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/numbers",
            "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."
              },
              {
                "name": "allocated_product",
                "value": "",
                "type": "query",
                "description": "The product associated with the allocated number."
              },
              {
                "name": "number_type",
                "value": "",
                "type": "query",
                "description": "The type of phone number."
              },
              {
                "name": "number_status",
                "value": "",
                "type": "query",
                "description": "The status of phone number."
              },
              {
                "name": "number_source",
                "value": "",
                "type": "query",
                "description": "The source of phone number."
              },
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "The site ID for the Zoom phone number."
              },
              {
                "name": "assigned_to_type",
                "value": "",
                "type": "query",
                "description": "The type of target assigned to the number."
              },
              {
                "name": "keyword",
                "value": "",
                "type": "query",
                "description": "This field allows you to search by phone number. Only prefix matching is available for search."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a list of phone numbers in an account. See section <b>Information in the phone number table</b> of [Using Number Management for managing phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074457#h_60222313850311712763891581) for more details.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `n"
        },
        {
          "info": {
            "name": "Delete phone numbers",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.zoom.us/v2/number_management/numbers",
            "params": [
              {
                "name": "numbers",
                "value": "",
                "type": "query",
                "description": "A list of phone numbers to be delete."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes phone numbers.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
        },
        {
          "info": {
            "name": "Get a phone number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/numbers/:phoneNumberId",
            "params": [
              {
                "name": "phoneNumberId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the phone number retrieved from the [List phone numbers](https://developers.zoom.us/docs/api/phone/#tag/carrier-reseller/GET/phone/carrier_reseller/numbers) API."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns information about an account's phone number. \n\nFor more details, see the section <b>Information in the phone number table</b> in [Using Number Management for managing phone numbers](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0074457#h_60222313850311712763891581).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-ove"
        },
        {
          "info": {
            "name": "Update a phone number",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.zoom.us/v2/number_management/numbers/:phoneNumberId",
            "params": [
              {
                "name": "phoneNumberId",
                "value": "",
                "type": "path",
                "description": "The unique identifier for the phone number retrieved from the List Phone Numbers API."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates a phone number's information.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        }
      ]
    },
    {
      "info": {
        "name": "Phone Plan",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List phone number plan information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/plan",
            "params": [
              {
                "name": "product",
                "value": "",
                "type": "query",
                "description": "The product (e.g., ZOOM_PHONE)."
              },
              {
                "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": "Retrieves an account's  phone number plan information, phone number usage, and availability.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:numbers_plan:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        }
      ]
    },
    {
      "info": {
        "name": "SMS Campaigns",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List SMS campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/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 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 all SMS campaigns in a Zoom account.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_sms_campaigns:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        },
        {
          "info": {
            "name": "Get an SMS campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/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/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management: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/number_management/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/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `numbe"
        },
        {
          "info": {
            "name": "Unassign phone number from SMS campaign",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.zoom.us/v2/number_management/sms_campaigns/:smsCampaignId/phone_numbers",
            "params": [
              {
                "name": "smsCampaignId",
                "value": "",
                "type": "path"
              },
              {
                "name": "phone_number_ids",
                "value": "",
                "type": "query",
                "description": "A list of phone numbers to unassign from the SMS campaign."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "[Unassigns a phone number from an SMS campaign](https://support.zoom.us/hc/en-us/articles/5016496738445-SMS-MMS-10DLC-Compliance-for-Zoom-Phone-and-Zoom-Contact-Center#h_01FYVVSPVM8MZN4Y9EW5690QHH).\n\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/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](ht"
        }
      ]
    },
    {
      "info": {
        "name": "SMS Consent",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List SMS consent policies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/sms_consent",
            "params": [
              {
                "name": "page_size",
                "value": "30",
                "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": "Returns a paginated list of SMS consent policies for the account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_consent:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
        },
        {
          "info": {
            "name": "Create an SMS consent policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zoom.us/v2/number_management/sms_consent",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a new SMS consent management policy to define opt-in, opt-out, and help message configurations for SMS communications.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:sms_consent:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        },
        {
          "info": {
            "name": "Delete SMS consent policies",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.zoom.us/v2/number_management/sms_consent",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes one or more SMS consent policies.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:sms_consent:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
        },
        {
          "info": {
            "name": "Get an SMS consent policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/sms_consent/:consentId",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "The consent policy's ID."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a specific SMS consent policy by ID.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_consent:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        },
        {
          "info": {
            "name": "Update an SMS consent policy",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.zoom.us/v2/number_management/sms_consent/:consentId",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "The consent policy's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an existing SMS consent policy. Only provided fields will be updated.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:update:sms_consent:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        },
        {
          "info": {
            "name": "List phone numbers assigned to SMS consent policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/sms_consent/:consentId/phone_numbers",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "The consent policy's ID."
              },
              {
                "name": "page_size",
                "value": "30",
                "type": "query",
                "description": "The number of records returned within a single API call."
              },
              {
                "name": "next_page_token",
                "value": "",
                "type": "query",
                "description": "Use the next page token to paginate through large result sets. A next page token is returned 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": "Returns a paginated list of phone numbers assigned to a specific SMS consent policy.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:sms_consent:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
        },
        {
          "info": {
            "name": "Assign phone numbers to SMS consent policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.zoom.us/v2/number_management/sms_consent/:consentId/phone_numbers",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "The consent policy's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Assigns one or more phone numbers to an SMS consent policy.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:write:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
        },
        {
          "info": {
            "name": "Unassign phone numbers from SMS consent policy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.zoom.us/v2/number_management/sms_consent/:consentId/phone_numbers",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "The consent policy's ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Unassigns one or more phone numbers from an SMS consent policy.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:delete:numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
        }
      ]
    },
    {
      "info": {
        "name": "Setting",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List ported numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/ported_numbers/orders",
            "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."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a list of ported numbers in a Zoom account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_ported_numbers:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        },
        {
          "info": {
            "name": "Get ported numbers details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/ported_numbers/orders/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "The order ID of the ported numbers. This ID can be retrieved from the List Ported Numbers API."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns the 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/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:ported_number:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits"
        },
        {
          "info": {
            "name": "List SIP groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/sip_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 returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
              },
              {
                "name": "allocated_product",
                "value": "",
                "type": "query",
                "description": "The phone number's allocated product."
              }
            ],
            "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/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_sip_groups:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/r"
        },
        {
          "info": {
            "name": "List BYOC SIP trunks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.zoom.us/v2/number_management/sip_trunks",
            "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."
              },
              {
                "name": "allocated_product",
                "value": "",
                "type": "query",
                "description": "The phone number's allocated product\r\n"
              }
            ],
            "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.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management_numbers:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `number_management:read:list_sip_trunks:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
        }
      ]
    }
  ],
  "bundled": true
}