Zoom Public API Documentation
List closures
GET {{baseUrl}}/contact_center/closures?next_page_token=<string>&page_size=30&account_default=<boolean>
Get a list of closures. Admins can create closures to select. Scopes: Rate Limit Label: contact_center_queue:read:admincontact_center_operating_hours:read:adminMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token 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. | |
account_default
|
string | Default business hours or closures for the newly-created queue. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"closure_sets": [
{
"account_default": "<boolean>",
"closure_set_id": "<string>",
"closure_set_name": "<string>",
"closures": [
{
"closure_hour_type": 2,
"closure_name": "<string>",
"end_time": "<string>",
"recurring_frequency": 0,
"start_time": "<string>",
"closure_id": "<string>",
"recurring_frequency_type": 1,
"recurring_month": 2,
"recurring_week_interval": "<integer>",
"recurring_days_of_week": [
"<string>",
"<string>"
]
},
{
"closure_hour_type": 2,
"closure_name": "<string>",
"end_time": "<string>",
"recurring_frequency": 3,
"start_time": "<string>",
"closure_id": "<string>",
"recurring_frequency_type": 1,
"recurring_month": 1,
"recurring_week_interval": "<integer>",
"recurring_days_of_week": [
"<string>",
"<string>"
]
}
],
"flows_count": "<integer>",
"queues_count": "<integer>",
"timezone": "<string>"
},
{
"account_default": "<boolean>",
"closure_set_id": "<string>",
"closure_set_name": "<string>",
"closures": [
{
"closure_hour_type": 1,
"closure_name": "<string>",
"end_time": "<string>",
"recurring_frequency": 2,
"start_time": "<string>",
"closure_id": "<string>",
"recurring_frequency_type": 2,
"recurring_month": 3,
"recurring_week_interval": "<integer>",
"recurring_days_of_week": [
"<string>",
"<string>"
]
},
{
"closure_hour_type": 2,
"closure_name": "<string>",
"end_time": "<string>",
"recurring_frequency": 1,
"start_time": "<string>",
"closure_id": "<string>",
"recurring_frequency_type": 1,
"recurring_month": 10,
"recurring_week_interval": "<integer>",
"recurring_days_of_week": [
"<string>",
"<string>"
]
}
],
"flows_count": "<integer>",
"queues_count": "<integer>",
"timezone": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/closures?next_page_token=<string>&page_size=30&account_default=<boolean>?next_page_token=<string>&page_size=30&account_default=<boolean>' -H 'Accept: application/json'
ENDPOINTS