Zoom Public API Documentation
List system statuses
GET {{baseUrl}}/contact_center/system_statuses?next_page_token=<string>&page_size=30&status_category=queue_opt_out_and_not_ready_status
Get a list of system statuses. Admins can create system statuses, such as "Maintenance". Scopes: Rate Limit Label: contact_center_preference:read:adminMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
status_category
|
string | The status's category. * `agent_status`: User’s system statuses. * `queue_opt_out_and_not_ready_status`: User’s "Queue Opt-Out" and "Not Ready" reasons. "Not Ready" reasons are referenced by field "sub_status_name" in the Users APIs (e.g. [List Users’ Profiles](https://developers.zoom.us/docs/contact-center/apis/#operation/users)) |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"statuses": [
{
"status_id": "<string>",
"status_name": "string",
"status_type": "default",
"status_category": "agent_status",
"enable": "<boolean>"
},
{
"status_id": "<string>",
"status_name": "Not Ready",
"status_type": "default",
"status_category": "agent_status",
"enable": "<boolean>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/system_statuses?next_page_token=<string>&page_size=30&status_category=queue_opt_out_and_not_ready_status?next_page_token=<string>&page_size=30&status_category=queue_opt_out_and_not_ready_status' -H 'Accept: application/json'
ENDPOINTS