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: phone:read:admin
Granular Scopes: phone:read:list_carrier_numbers:admin
Rate Limit Label: Medium
Request Params
| 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":"\u003cinteger\u003e","country_iso_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","status":"inactive","sub_account_id":"\u003cstring\u003e","sub_account_name":"\u003cstring\u003e"},{"assigned_status":"returned","carrier_code":"\u003cinteger\u003e","country_iso_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","status":"active","sub_account_id":"\u003cstring\u003e","sub_account_name":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e"}