Zoom Public API Documentation
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: Granular Scopes: Rate Limit Label: phone:read:admin,phone_peering:read:adminphone:read:list_ported_numbers:adminMedium
Body
PARAM
| 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": "<string>",
"page_size": "<integer>",
"ported_numbers": [
{
"numbers": [
"<string>",
"<string>"
],
"order_id": "<string>",
"replacing_numbers": [
{
"source_number": "<string>",
"target_number": "<string>"
},
{
"source_number": "<string>",
"target_number": "<string>"
}
],
"status": "Canceled",
"submission_date_time": "<string>"
},
{
"numbers": [
"<string>",
"<string>"
],
"order_id": "<string>",
"replacing_numbers": [
{
"source_number": "<string>",
"target_number": "<string>"
},
{
"source_number": "<string>",
"target_number": "<string>"
}
],
"status": "Waiting",
"submission_date_time": "<string>"
}
],
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/ported_numbers/orders?next_page_token=<string>&page_size=30?next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS