Zoom Public API Documentation
List group call pickup objects
GET {{baseUrl}}/phone/group_call_pickup?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&site_id=NjHmTu16Qfe8yOiNJuekXA
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: Rate Limit Label: phone:read: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 is used to paginate through large result sets. A next page token will be 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": "qLZ4vXb8RAydayOR5ckYMg",
"display_name": "testGCP",
"extension_id": "testGCP",
"extension_number": 10002,
"member_count": 1,
"description": "test",
"delay": 0,
"cost_center": "test",
"department": "test",
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "testGCPSite"
},
"directed_call_pickup": true
},
{
"id": "qLZ4vXb8RAydayOR5ckYMg",
"display_name": "testGCP",
"extension_id": "testGCP",
"extension_number": 10002,
"member_count": 1,
"description": "test",
"delay": 0,
"cost_center": "test",
"department": "test",
"site": {
"id": "8f71O6rWT8KFUGQmJIFAdQ",
"name": "testGCPSite"
},
"directed_call_pickup": true
}
],
"next_page_token": "BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2",
"page_size": 30,
"total_records": 1
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/group_call_pickup?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&site_id=NjHmTu16Qfe8yOiNJuekXA?page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&site_id=NjHmTu16Qfe8yOiNJuekXA' -H 'Accept: application/json'
ENDPOINTS