Zoom Public API Documentation
List activation codes
GET {{baseUrl}}/phone/common_areas/activation_codes?page_size=30&next_page_token=<string>
Returns a list of activation code information of the common areas under an account. Note: This API serves customers who opted for Prerequisites:
* Pro or a higher account with Zoom Phone license
* Account owner or admin permissions Scopes: Granular Scopes: Rate Limit Label: Not supported in Gov cluster Common Area Optimization. phone:read:adminphone:read:list_common_area_activation_codes:adminMEDIUM
Body
PARAM
| 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 returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"common_areas_activation_codes": [
{
"common_area_id": "<string>",
"display_name": "<string>",
"extension_number": "<long>",
"activation_code": "<string>",
"activation_code_expiration": "<string>",
"status": "not_used",
"site": {
"site_id": "<string>",
"name": "<string>"
}
},
{
"common_area_id": "<string>",
"display_name": "<string>",
"extension_number": "<long>",
"activation_code": "<string>",
"activation_code_expiration": "<string>",
"status": "not_used",
"site": {
"site_id": "<string>",
"name": "<string>"
}
}
],
"next_page_token": "<string>",
"page_size": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/common_areas/activation_codes?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS