Zoom Public API Documentation
List group call pickup objects
GET {{baseUrl}}/phone/group_call_pickup?page_size=30&next_page_token=<string>&site_id=<string>
Use this API to retrieve a list of Group Call Pickup objects in an account. Prerequisites:
* A Pro or higher account plan
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_call_pickup_groups:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
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. | |
site_id
|
string | Unique identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"group_call_pickup": [
{
"id": "<string>",
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"member_count": "<integer>",
"description": "<string>",
"delay": 10,
"cost_center": "<string>",
"department": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"directed_call_pickup": "<boolean>"
},
{
"id": "<string>",
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"member_count": "<integer>",
"description": "<string>",
"delay": 10,
"cost_center": "<string>",
"department": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"directed_call_pickup": "<boolean>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/group_call_pickup?page_size=30&next_page_token=<string>&site_id=<string>?page_size=30&next_page_token=<string>&site_id=<string>' -H 'Accept: application/json'
ENDPOINTS