Zoom Public API Documentation
Get an engagement
GET {{baseUrl}}/contact_center/engagements/:engagementId
Get information about an engagement. Scopes: Rate Limit Label: contact_center_engagement:read:adminLIGHT
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"start_time": "<dateTime>",
"duration": "<long>",
"engagement_id": "<string>",
"channel_types": [
"sms",
"sms"
],
"consumers": [
{
"consumer_id": "<string>",
"consumer_display_name": "<string>",
"consumer_number": "<string>"
},
{
"consumer_id": "<string>",
"consumer_display_name": "<string>",
"consumer_number": "<string>"
}
],
"direction": "outbound",
"flows": [
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_version": "<string>"
},
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_version": "<string>"
}
],
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"queue_wait_type": "callback",
"flow_duration": "<long>",
"waiting_duration": "<long>",
"handling_duration": "<long>",
"wrap_up_duration": "<long>",
"voice_mail": "<integer>",
"dispositions": [
{
"disposition_id": "<string>",
"disposition_name": "<string>"
},
{
"disposition_id": "<string>",
"disposition_name": "<string>"
}
],
"notes": [
{
"user_id": "<string>",
"note_id": "<string>",
"note": "<string>",
"last_modified_time": "<dateTime>"
},
{
"user_id": "<string>",
"note_id": "<string>",
"note": "<string>",
"last_modified_time": "<dateTime>"
}
],
"events": [
{
"start_time": "<dateTime>",
"duration": "<long>",
"channel_type": "sms",
"event_type": "<string>",
"direction": "outbound",
"flow_id": "<string>",
"flow_name": "<string>",
"queue_id": "<string>",
"queue_name": "<string>",
"user_id": "<string>",
"user_display_name": "<string>",
"accept_type": "auto",
"transfer_to_flow_id": "<string>",
"transfer_to_flow_name": "<string>",
"transfer_to_queue_id": "<string>",
"transfer_to_queue_name": "<string>",
"transfer_to_user_id": "<string>",
"transfer_to_user_display_name": "<string>",
"transfer_to_number": "<string>",
"transfer_type": "warm",
"upgraded_to_channel_type": "video",
"crm_type": "<string>",
"crm_call_status": "hangup",
"supervisor_id": "<string>",
"supervisor_display_name": "<string>",
"consumer_id": "<string>",
"consumer_display_name": "<string>",
"inbox_id": "<string>",
"inbox_name": "<string>",
"skills": [
{
"skill_category_id": "<string>",
"skill_category_name": "<string>",
"skill_id": "<string>",
"skill_name": "<string>",
"skill_proficiency_level": "<integer>"
},
{
"skill_category_id": "<string>",
"skill_category_name": "<string>",
"skill_id": "<string>",
"skill_name": "<string>",
"skill_proficiency_level": "<integer>"
}
]
},
{
"start_time": "<dateTime>",
"duration": "<long>",
"channel_type": "sms",
"event_type": "<string>",
"direction": "outbound",
"flow_id": "<string>",
"flow_name": "<string>",
"queue_id": "<string>",
"queue_name": "<string>",
"user_id": "<string>",
"user_display_name": "<string>",
"accept_type": "manual",
"transfer_to_flow_id": "<string>",
"transfer_to_flow_name": "<string>",
"transfer_to_queue_id": "<string>",
"transfer_to_queue_name": "<string>",
"transfer_to_user_id": "<string>",
"transfer_to_user_display_name": "<string>",
"transfer_to_number": "<string>",
"transfer_type": "warm",
"upgraded_to_channel_type": "video",
"crm_type": "<string>",
"crm_call_status": "miss",
"supervisor_id": "<string>",
"supervisor_display_name": "<string>",
"consumer_id": "<string>",
"consumer_display_name": "<string>",
"inbox_id": "<string>",
"inbox_name": "<string>",
"skills": [
{
"skill_category_id": "<string>",
"skill_category_name": "<string>",
"skill_id": "<string>",
"skill_name": "<string>",
"skill_proficiency_level": "<integer>"
},
{
"skill_category_id": "<string>",
"skill_category_name": "<string>",
"skill_id": "<string>",
"skill_name": "<string>",
"skill_proficiency_level": "<integer>"
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/engagements/:engagementId' -H 'Accept: application/json'
ENDPOINTS