Logo
Zoom Public API Documentation

List engagement recordings

GET {{baseUrl}}/contact_center/engagements/:engagementId/recordings?channel_type=voice&from=<string>&to=<string>&next_page_token=<string>&page_size=30

Return a list of all recordings in an engagement.

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

 

Body PARAM

Key Datatype Required Description 
channel_type
string The recording's channel type. * `voice` &mdash; Voice recording * `video` &mdash; Video recording
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 the `from` parameter 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 the `from` parameter.
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
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/engagements/:engagementId/recordings?channel_type=voice&from=<string>&to=<string>&next_page_token=<string>&page_size=30?channel_type=voice&from=<string>&to=<string>&next_page_token=<string>&page_size=30' -H 'Accept: application/json'

ENDPOINTS