Zoom Public API Documentation
List tasks
GET {{baseUrl}}/contact_center/tasks?task_status=wrapping&queue_id=<string>&engagement_id=<string>&next_page_token=<string>
Use this API to return a list of tasks. Scopes: Rate Limit Label: contact_center_task:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
task_status
|
string | The task's status: * `pending` * `reserved` * `assigned` * `canceled` * `completed` * `wrapping` | |
queue_id
|
string | The task's queue ID. | |
engagement_id
|
string | The task's engagement ID. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"tasks": [
{
"task_id": "<string>",
"workspace_id": "<string>",
"task_timeout": "<integer>",
"task_priority": "<integer>",
"task_status": "reserved",
"channel_id": "<string>",
"channel_name": "default",
"queue_id": "<string>",
"queue_name": "<string>",
"flow_id": "<string>",
"flow_name": "<string>",
"engagement_id": "<string>",
"caller_number": "<string>",
"callee_number": "<string>",
"assigned_user_id": "<string>",
"auto_assign": "<boolean>",
"created_time": "<dateTime>",
"last_modified_time": "<dateTime>"
},
{
"task_id": "<string>",
"workspace_id": "<string>",
"task_timeout": "<integer>",
"task_priority": "<integer>",
"task_status": "canceled",
"channel_id": "<string>",
"channel_name": "phone",
"queue_id": "<string>",
"queue_name": "<string>",
"flow_id": "<string>",
"flow_name": "<string>",
"engagement_id": "<string>",
"caller_number": "<string>",
"callee_number": "<string>",
"assigned_user_id": "<string>",
"auto_assign": "<boolean>",
"created_time": "<dateTime>",
"last_modified_time": "<dateTime>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/tasks?task_status=wrapping&queue_id=<string>&engagement_id=<string>&next_page_token=<string>?task_status=wrapping&queue_id=<string>&engagement_id=<string>&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS