List ported numbers
GET {{baseUrl}}/phone/ported_numbers/orders?next_page_token=<string>&page_size=30
Use this API to list ported numbers in a Zoom account.
Prerequisites:
- A Pro or higher account plan
- A Zoom Phone license
Scopes:
phone:read:admin
,
phone_peering:read:admin
Granular Scopes:
phone:read:list_ported_numbers:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| 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. |
| page_size | number | | The number of records returned within a single API call. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","ported_numbers":[{"numbers":["\u003cstring\u003e","\u003cstring\u003e"],"order_id":"\u003cstring\u003e","replacing_numbers":[{"source_number":"\u003cstring\u003e","target_number":"\u003cstring\u003e"},{"source_number":"\u003cstring\u003e","target_number":"\u003cstring\u003e"}],"status":"Canceled","submission_date_time":"\u003cstring\u003e"},{"numbers":["\u003cstring\u003e","\u003cstring\u003e"],"order_id":"\u003cstring\u003e","replacing_numbers":[{"source_number":"\u003cstring\u003e","target_number":"\u003cstring\u003e"},{"source_number":"\u003cstring\u003e","target_number":"\u003cstring\u003e"}],"status":"Waiting","submission_date_time":"\u003cstring\u003e"}],"total_records":"\u003cinteger\u003e"}