Get call recordings
GET {{baseUrl}}/phone/recordings?page_size=<integer>&next_page_token=<string>&from=<date>&to=<date>&owner_type=all&recording_type=<string>&site_id=All sites&query_date_type=start_time&group_id=All groups
Returns an account's call recordings .
Prerequisites:
- A Pro or higher account plan
- A Zoom Phone license
- Account owner or admin privileges
Scopes:
phone:read:admin
,
phone_recording:read:admin
Granular Scopes:
phone:read:list_call_recordings:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| page_size
| string | | The number of records returned within a single API call.
The default is 30 and the maximum is 300. |
| next_page_token
| string | | The current page number of the returned records. |
| from
| string | | The start time and date in yyyy-mm-dd or yyyy-MM-dd T HH:mm:ssZ format.
The date range defined in the from
and to
parameters should be a month as the response only includes one month's worth of data at once.
If unspecified, it returns data from the past 30 days. |
| to
| string | | This field is required only when the from
parameter is specified.
The end time and date display in yyyy-mm-dd or yyyy-MM-dd T HH:mm:ssZ format, which is the same format as the from
parameter. |
| owner_type
| string | | The owner type.
The allowed values are null
, user
, or callQueue
.
The default value is null
. If the value is null
, it returns all owner types. |
| recording_type
| string | | The recording type. The allowed values are null
, OnDemand
, or Automatic
. The default value is null
. If null
, it returns all recording types. |
| site_id
| string | | The site ID.
The default value is All sites
. |
| query_date_type
| string | | The query date type, which can be start_time
or end_time
.
The default value is start_time
. |
| group_id
| string | | The group ID.
The default value is All groups
. |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","recordings":[{"auto_delete_policy":"\u003cstring\u003e","call_id":"\u003cstring\u003e","call_log_id":"\u003cstring\u003e","callee_name":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_number_type":3,"caller_name":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_number_type":1,"outgoing_by":{"name":"\u003cstring\u003e","extension_number":"\u003cstring\u003e"},"accepted_by":{"name":"\u003cstring\u003e","extension_number":"\u003cstring\u003e"},"date_time":"\u003cdateTime\u003e","disclaimer_status":2,"direction":"outbound","download_url":"\u003cstring\u003e","duration":"\u003cinteger\u003e","end_time":"\u003cdateTime\u003e","id":"\u003cstring\u003e","meeting_uuid":"\u003cstring\u003e","owner":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"call queue","extension_status":"inactive","extension_deleted_time":"\u003cstring\u003e"},"recording_type":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"transcript_download_url":"\u003cstring\u003e","auto_delete_enable":"\u003cboolean\u003e"},{"auto_delete_policy":"\u003cstring\u003e","call_id":"\u003cstring\u003e","call_log_id":"\u003cstring\u003e","callee_name":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_number_type":3,"caller_name":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_number_type":1,"outgoing_by":{"name":"\u003cstring\u003e","extension_number":"\u003cstring\u003e"},"accepted_by":{"name":"\u003cstring\u003e","extension_number":"\u003cstring\u003e"},"date_time":"\u003cdateTime\u003e","disclaimer_status":1,"direction":"outbound","download_url":"\u003cstring\u003e","duration":"\u003cinteger\u003e","end_time":"\u003cdateTime\u003e","id":"\u003cstring\u003e","meeting_uuid":"\u003cstring\u003e","owner":{"extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"user","extension_status":"deleted","extension_deleted_time":"\u003cstring\u003e"},"recording_type":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"transcript_download_url":"\u003cstring\u003e","auto_delete_enable":"\u003cboolean\u003e"}],"total_records":"\u003cinteger\u003e"}