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

KeyDatatypeRequiredDescription
next_page_tokenstringUse 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_sizenumberThe number of items returned per page.
timezonestringThe call's timezone. The default is UTC.
fromstringThe 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.
tostringRequired 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_idstringThe queue's ID.
user_idstringThe agent's ID.
consumer_numberstringThe customer's phone number.
channel_typesstringThe 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:10,&quot;total_records&quot;:&quot;\u003cinteger\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;,&quot;from&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;to&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;engagements&quot;:[{&quot;start_time&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;duration&quot;:&quot;\u003clong\u003e&quot;,&quot;engagement_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel_types&quot;:[&quot;sms&quot;,&quot;voice&quot;],&quot;consumers&quot;:[{&quot;consumer_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_number&quot;:&quot;\u003cstring\u003e&quot;},{&quot;consumer_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_number&quot;:&quot;\u003cstring\u003e&quot;}],&quot;dispositions&quot;:[{&quot;disposition_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;disposition_name&quot;:&quot;\u003cstring\u003e&quot;},{&quot;disposition_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;disposition_name&quot;:&quot;\u003cstring\u003e&quot;}],&quot;notes&quot;:[{&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_modified_time&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_modified_time&quot;:&quot;\u003cdateTime\u003e&quot;}]},{&quot;start_time&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;duration&quot;:&quot;\u003clong\u003e&quot;,&quot;engagement_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel_types&quot;:[&quot;sms&quot;,&quot;sms&quot;],&quot;consumers&quot;:[{&quot;consumer_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_number&quot;:&quot;\u003cstring\u003e&quot;},{&quot;consumer_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_display_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;consumer_number&quot;:&quot;\u003cstring\u003e&quot;}],&quot;dispositions&quot;:[{&quot;disposition_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;disposition_name&quot;:&quot;\u003cstring\u003e&quot;},{&quot;disposition_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;disposition_name&quot;:&quot;\u003cstring\u003e&quot;}],&quot;notes&quot;:[{&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_modified_time&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;note&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_modified_time&quot;:&quot;\u003cdateTime\u003e&quot;}]}]}