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:
phone:read:admin
,
phone_peering:read:admin
Granular Scopes:
phone:read:list_peering_numbers:admin
Rate Limit Label
:
Light
Request Params
| 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":"\u003cstring\u003e","numbers":[{"assigned":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","sip_trunk_name":"\u003cstring\u003e","status":"\u003cinteger\u003e","billing_reference_id":"\u003cstring\u003e","service_info":"\u003cstring\u003e"},{"assigned":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","sip_trunk_name":"\u003cstring\u003e","status":"\u003cinteger\u003e","billing_reference_id":"\u003cstring\u003e","service_info":"\u003cstring\u003e"}],"total_records":"\u003cinteger\u003e"}