List engagements
GET {{baseUrl}}/contact_center/engagements?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_id=<string>&user_id=<string>&consumer_number=<string>&channel_types=in_app_video&channel_types=video
Returns a list of engagements.
Scopes:
contact_center_engagement:read:admin
Rate Limit Label
:
MEDIUM
Request Params
| 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. |
| timezone | string | | The call's timezone. The default is UTC. |
| from | string | | The start time and date, in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours. |
| to | string | | Required only when the from parameter is specified. The end time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format, the same format as the from parameter. |
| queue_id | string | | The queue's ID. |
| user_id | string | | The agent's ID. |
| consumer_number | string | | The customer's phone number. |
| channel_types | string | | The channel's type.
- voice
- SMS
- chat
- video
- kiosk
- in_app_chat
- in_app_video |
|
channel_types| string | | The channel's type. - voice
- SMS
- chat
- video
- kiosk
- in_app_chat
- in_app_video |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","timezone":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e","engagements":[{"start_time":"\u003cdateTime\u003e","duration":"\u003clong\u003e","engagement_id":"\u003cstring\u003e","channel_types":["sms","voice"],"consumers":[{"consumer_id":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"},{"consumer_id":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"}],"dispositions":[{"disposition_id":"\u003cstring\u003e","disposition_name":"\u003cstring\u003e"},{"disposition_id":"\u003cstring\u003e","disposition_name":"\u003cstring\u003e"}],"notes":[{"user_id":"\u003cstring\u003e","note_id":"\u003cstring\u003e","note":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e"},{"user_id":"\u003cstring\u003e","note_id":"\u003cstring\u003e","note":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e"}]},{"start_time":"\u003cdateTime\u003e","duration":"\u003clong\u003e","engagement_id":"\u003cstring\u003e","channel_types":["sms","sms"],"consumers":[{"consumer_id":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"},{"consumer_id":"\u003cstring\u003e","consumer_display_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"}],"dispositions":[{"disposition_id":"\u003cstring\u003e","disposition_name":"\u003cstring\u003e"},{"disposition_id":"\u003cstring\u003e","disposition_name":"\u003cstring\u003e"}],"notes":[{"user_id":"\u003cstring\u003e","note_id":"\u003cstring\u003e","note":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e"},{"user_id":"\u003cstring\u003e","note_id":"\u003cstring\u003e","note":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e"}]}]}