Zoom Public API Documentation
List carrier peering phone numbers.
GET {{baseUrl}}/phone/carrier_peering/numbers?page_size=30&next_page_token=<string>&phone_number=<string>
Returns phone numbers pushed by the carrier to different customers.
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 | To filter results by the given phone number. |
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>",
"customer_account_name": "<string>",
"customer_account_number": "<string>",
"billing_reference_id": "<string>",
"service_info": "<string>"
},
{
"assigned": "<integer>",
"phone_number": "<string>",
"sip_trunk_name": "<string>",
"status": "<integer>",
"customer_account_name": "<string>",
"customer_account_number": "<string>",
"billing_reference_id": "<string>",
"service_info": "<string>"
}
],
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/carrier_peering/numbers?page_size=30&next_page_token=<string>&phone_number=<string>?page_size=30&next_page_token=<string>&phone_number=<string>' -H 'Accept: application/json'
ENDPOINTS