Zoom Public API Documentation
Get a queue
GET {{baseUrl}}/contact_center/queues/:queueId
Get information about a queue. Scopes: Rate Limit Label: contact_center_queue:read:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"queue_id": "<string>",
"queue_name": "<string>",
"queue_description": "<string>",
"dispositions_count": "<integer>",
"disposition_sets_count": "<integer>",
"channel_types": [
"chat",
"in_app_chat"
],
"max_wait_time": "<integer>",
"wrap_up_time": "<integer>",
"max_engagement_in_queue": "<integer>",
"short_abandon": {
"enable": "<boolean>",
"threshold": "<integer>"
},
"distribution_type": null,
"distribution_duration_in_seconds": "<integer>",
"connecting_media_id": "<string>",
"connecting_media_name": "<string>",
"transferring_media_id": "<string>",
"transferring_media_name": "<string>",
"holding_media_id": "<string>",
"holding_media_name": "<string>",
"waiting_room_name": "<string>",
"waiting_room_id": "<string>",
"message_accept": "auto",
"wrap_up_expiration": "<boolean>",
"overflow_to_goodbye_message": "<boolean>",
"overflow_to_queue_id": "<string>",
"overflow_to_flow_id": "<string>",
"overflow_to_inbox_id": "<string>",
"auto_close_message": "<string>",
"auto_close_message_enabled": "<boolean>",
"auto_close_timeout": "<integer>",
"auto_close_alert_message": "<string>",
"auto_close_alert_message_enabled": "<boolean>",
"auto_close_alert_message_time": "<integer>",
"recording_storage_location": "us - United States",
"service_level_threshold_in_seconds": "<integer>",
"service_level_exclude_short_abandoned_calls": "<boolean>",
"service_level_exclude_long_abandoned_calls": "<boolean>",
"service_level_exclude_abandoned_quit_engagements": "<boolean>",
"service_level_target_in_percentage": "<integer>",
"agent_routing_profile_id": "<string>",
"agent_routing_profile_name": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/queues/:queueId' -H 'Accept: application/json'
ENDPOINTS