List peering phone numbers
GET {{baseUrl}}/phone/peering/numbers?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&phone_number=18108001001&carrier_code=8801
Use this API to return phone numbers that were added to Zoom through the Provider Exchange.
Note: Phone peering API and events are for use by partners that have completed the MoU to peer with Zoom. To become a peering provider/ carrier, please submit your request.
Scopes: phone_peering:read:admin, phone_peering:master
Rate Limit Label: Light
Prerequisites: * A Business or Enterprise account * A Zoom Phone license
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 is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
phone_number | number | Either the sender's or receiver's phone number, to limit the list of SMS sessions. | |
carrier_code | number | The carrier's code. The clientId is used to map 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":"8X8xSdRVKHsabD6Im4tIPODq6GzDOvV5fO1","numbers":[{"phone_number":"+18108001001","status":0,"assigned":1,"sip_trunk_name":"test-carrier-sip-trunk","billing_reference_id":"Some billing referenceId","service_info":"Some service info"},{"phone_number":"+18108001001","status":0,"assigned":1,"sip_trunk_name":"test-carrier-sip-trunk","billing_reference_id":"Some billing referenceId","service_info":"Some service info"}],"total_records":20}