Zoom Public API Documentation
List call pickup group members
GET {{baseUrl}}/phone/group_call_pickup/:groupId/members?page_size=30&next_page_token=<string>&site_id=<string>&extension_type=commonArea
Use this API to retrieve members of a call pickup group in an account. Prerequisites:
* A Pro or higher account plan
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:call_pickup_group_member: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. | |
extension_type
|
string | Type of the assignee. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"group_call_pickup_member": [
{
"id": "<string>",
"display_name": "<string>",
"extension_id": "<string>",
"extension_type": "commonArea",
"extension_number": "<long>"
},
{
"id": "<string>",
"display_name": "<string>",
"extension_id": "<string>",
"extension_type": "user",
"extension_number": "<long>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/group_call_pickup/:groupId/members?page_size=30&next_page_token=<string>&site_id=<string>&extension_type=commonArea?page_size=30&next_page_token=<string>&site_id=<string>&extension_type=commonArea' -H 'Accept: application/json'
ENDPOINTS