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

KeyDatatypeRequiredDescription
page_sizenumberThe total number of records returned from a single API call.
next_page_tokenstringThe 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_numberstringThe sender's or receiver's phone number that limits the list of SMS sessions.
carrier_codestringThe 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;numbers&quot;:[{&quot;assigned&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;sip_trunk_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cinteger\u003e&quot;,&quot;billing_reference_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;service_info&quot;:&quot;\u003cstring\u003e&quot;},{&quot;assigned&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;sip_trunk_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cinteger\u003e&quot;,&quot;billing_reference_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;service_info&quot;:&quot;\u003cstring\u003e&quot;}],&quot;total_records&quot;:&quot;\u003cinteger\u003e&quot;}