Zoom Public API Documentation
List peering phone numbers
GET {{baseUrl}}/phone/peering/numbers?page_size=30&next_page_token=<string>&phone_number=<string>&carrier_code=<integer>
Returns phone numbers to Zoom through the Provider Exchange. 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. Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:admin,phone_peering:read:adminphone:read:list_peering_numbers:adminLight
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The total number of records returned from a single API call. | |
next_page_token
|
string | 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. | |
phone_number
|
string | The sender's or receiver's phone number that limits the list of SMS sessions. | |
carrier_code
|
string | The carrier's code. The `clientId` that 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`. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"numbers": [
{
"assigned": "<integer>",
"phone_number": "<string>",
"sip_trunk_name": "<string>",
"status": "<integer>",
"billing_reference_id": "<string>",
"service_info": "<string>"
},
{
"assigned": "<integer>",
"phone_number": "<string>",
"sip_trunk_name": "<string>",
"status": "<integer>",
"billing_reference_id": "<string>",
"service_info": "<string>"
}
],
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/peering/numbers?page_size=30&next_page_token=<string>&phone_number=<string>&carrier_code=<integer>?page_size=30&next_page_token=<string>&phone_number=<string>&carrier_code=<integer>' -H 'Accept: application/json'
ENDPOINTS