List recordings
GET {{baseUrl}}/contact_center/recordings?query_date_type=recording_start_time&from=<string>&to=<string>&recording_type=automatic&owner_type=user&channel_type=voice&next_page_token=<string>&page_size=30
Return a list of available recordings.
Note : Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes:
contact_center_recording:read:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| query_date_type | string | | Query date type.
recording_start_time— The recording's start timerecording_end_time— The recording's end time | |from| string | | The start time and date in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss'Z', or yyyy-MM-dd'T'HH:mm:ss'TZD'. The defined date range should be a month, as the response only includes one month's worth of data. If unspecified, this parameter returns data from the past 30 days. | |to| string | | Required only when thefromparameter is specified. The end time and date in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss'Z', or yyyy-MM-dd'T'HH:mm:ss'TZD', the same format as thefromparameter. | |recording_type| string | | The recording's type.on_demand— Manually trigger recordingautomatic— Automatically trigger recording | |owner_type| string | | The recording's owner type.user— This recording belongs to a userqueue— This recording belongs to a queue | |channel_type| string | | The recording's channel type.voice— Voice recordingvideo— Video recording | |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. | |page_size| number | | The number of items returned per page. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"from":"\u003cstring\u003e","to":"\u003cstring\u003e","recordings":[{"recording_id":"\u003cstring\u003e","queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","recording_duration":"\u003cinteger\u003e","download_url":"\u003cstring\u003e","transcript_url":"\u003cstring\u003e","playback_url":"\u003cstring\u003e","recording_start_time":"\u003cdateTime\u003e","recording_end_time":"\u003cdateTime\u003e","user_id":"\u003cstring\u003e","user_email":"\u003cstring\u003e","display_name":"\u003cstring\u003e","recording_type":"on_demand","channel_type":"video","direction":"outbound","owner_id":"\u003cstring\u003e","owner_name":"\u003cstring\u003e","owner_type":"user","engagement_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e","flow_id":"\u003cstring\u003e","consumer_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e","consumers":[{"consumer_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"},{"consumer_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"}]},{"recording_id":"\u003cstring\u003e","queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","recording_duration":"\u003cinteger\u003e","download_url":"\u003cstring\u003e","transcript_url":"\u003cstring\u003e","playback_url":"\u003cstring\u003e","recording_start_time":"\u003cdateTime\u003e","recording_end_time":"\u003cdateTime\u003e","user_id":"\u003cstring\u003e","user_email":"\u003cstring\u003e","display_name":"\u003cstring\u003e","recording_type":"automatic","channel_type":"voice","direction":"outbound","owner_id":"\u003cstring\u003e","owner_name":"\u003cstring\u003e","owner_type":"queue","engagement_id":"\u003cstring\u003e","flow_name":"\u003cstring\u003e","flow_id":"\u003cstring\u003e","consumer_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e","consumers":[{"consumer_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"},{"consumer_name":"\u003cstring\u003e","consumer_number":"\u003cstring\u003e"}]}]}