Zoom Public API Documentation
List phone numbers
GET {{baseUrl}}/phone/carrier_reseller/numbers?page_size=<integer>&next_page_token=<string>&assigned_status=unassigned&sub_account_id=<string>&keyword=<string>
Use this API to list phone numbers in a carrier reseller (master) account that can be pushed to its subaccounts. Prerequisites:
* A Pro or higher account plan
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_carrier_numbers:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
string | The size of the page. | |
next_page_token
|
string | The current page number of returned records. | |
assigned_status
|
string | Number assignment status. | |
sub_account_id
|
string | Partner account ID from sub-account. | |
keyword
|
string | Partial string of the phone number. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"carrier_reseller_numbers": [
{
"assigned_status": "unassigned",
"carrier_code": "<integer>",
"country_iso_code": "<string>",
"phone_number": "<string>",
"status": "inactive",
"sub_account_id": "<string>",
"sub_account_name": "<string>"
},
{
"assigned_status": "returned",
"carrier_code": "<integer>",
"country_iso_code": "<string>",
"phone_number": "<string>",
"status": "active",
"sub_account_id": "<string>",
"sub_account_name": "<string>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/carrier_reseller/numbers?page_size=<integer>&next_page_token=<string>&assigned_status=unassigned&sub_account_id=<string>&keyword=<string>?page_size=<integer>&next_page_token=<string>&assigned_status=unassigned&sub_account_id=<string>&keyword=<string>' -H 'Accept: application/json'
ENDPOINTS