Phone Webhooks

• call_id (required)

  string — The call ID.

• id (required)

  string — The recording ID.

• call_id (required)

  string — Unique identifier of the call.

• call_type (required)

  string, possible values: "voip", "pstn", "tollfree", "international", "contactCenter" — The type of call: * `voip` (Voice over IP) * `pstn` (Public Switched Telephone Network) * `tollfree` * `international` * `contactCenter`

• callee_number (required)

  string — Phone number of the callee.

• callee_number_type (required)

  integer, possible values: 1, 2, 3 — The callee's phone number type: * `1` — extension number. * `2` — phone number. * `3` — Customized emergency number.

• caller_number (required)

  string — Phone number of the caller.

• caller_number_type (required)

  integer, possible values: 1, 2 — Phone number type of the caller. The value can be one of the following: * `1` - extension number. * `2` - phone number.

• date_time (required)

  string, format: date-time — Start date and time of the call.

• has_voicemail (required)

  boolean — Indicates whether the call log includes voicemail or not.

• id (required)

  string — Unique Identifier of the call log.

• path (required)

  string — Path of the call log.

• result (required)

  string — Status of the call.

• call_end_time

  string, format: date-time — End time of the call.

• callee_country_code

  string — Callee's country code.

• callee_country_iso_code

  string — ISO alpha2 country code.

• callee_did_number

  string — Callee's DID number.

• callee_location

  string — Location of the callee.

• callee_name

  string — Name of the callee.

• callee_number_source

  string, possible values: "internal", "external", "byop" — Phone number source of the caller. The value can be one of the following: * `internal` - ZP native. * `external` — BYOC or Provider Exchange. * `byop` — Premise peering. Not available when `callee_number_type = 1`.

• caller_country_code

  string — Caller's country code.

• caller_country_iso_code

  string — ISO alpha2 country code.

• caller_did_number

  string — Caller's DID number.

• caller_location

  string — Location of the caller.

• caller_name

  string — Name of the caller.

• caller_number_source

  string, possible values: "internal", "external", "byop" — Phone number source of the caller. The value can be one of the following: * `internal` - ZP native. * `external` — BYOC or Provider Exchange. * `byop` — Premise peering. Not available when `caller_number_type = 1`.

• client_code

  string — Client code.

• cost_center

  string — Cost center name.

• department

  string — Department name.

• direction

  string, possible values: "inbound", "outbound" — Direction of the call. The value of this field can either be `inbound` or `outbound`.

• duration

  integer — Duration of the call.

• forwarded_by

  object — Indicates where the call was forwarded from.

  • extension_number

    string

  • extension_type

    string, possible values: "user", "callQueue", "autoReceptionist", "sharedLineGroup"

  • location

    string

  • name

    string

  • number_type

    integer — Phone number types: `1` - Extension `2`- E164 number `3` - Custom number.

  • phone_number

    string

• forwarded_to

  object — Indicates who the call was forwarded to.

  • extension_number

    string

  • extension_type

    string, possible values: "user", "callQueue", "autoReceptionist", "sharedLineGroup", "pstn"

  • location

    string

  • name

    string

  • number_type

    integer — Phone number types: `1` - Extension `2`- E164 number `3` - Custom number.

  • phone_number

    string

• has_recording

  boolean — Indicates whether the call log includes recording or not.

• hold_time

  integer — Hold time during a call in seconds.

• recording_id

  string — ID of this recording.

• recording_type

  string — Recording type of the call. This value field can be `OnDemand` or `Automatic`.

• site

  object

  • id

    string — The phone number's assigned target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites). Sites allow you to organize the phone users in your organization. For example, sites created and based on different office locations.

• callee_name (required)

  string — The name of the callee.

• callee_number (required)

  string — The phone number of the callee.

• callee_number_type (required)

  integer, possible values: 1, 2 — The phone number type of the callee. The value can be one of the following: * `1` - internal * `2` - external

• caller_number (required)

  string — The phone number of the caller.

• caller_number_type (required)

  integer, possible values: 1, 2 — The phone number type of the caller. The value can be one of the following: * `1` - internal * `2` - external

• date_time (required)

  string, format: date-time — The start date and time of the call.

• direction (required)

  string, possible values: "inbound", "outbound" — The direction of the call. The value of this field can either be `inbound` or `outbound`.

• download_url (required)

  string — The URL to download the call recording. To download the recording via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter. For example, if the value of this field is "https://zoom.us/v2/phone/recording/download/abcD666T”, the complete URL path to download the recording will be as below: `https://zoom.us/v2/phone/recording/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}`

• duration (required)

  integer — The duration of the call in seconds.

• id (required)

  string — The recording ID is the unique Identifier of the call recording.

• accepted_by

  object — The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.

  • extension_number

    string — The user extension number.

  • name

    string — User name

• call_element_id

  string — The call element ID.

• call_history_id

  string — Use `call_element_id` instead. The call history ID.

• call_id

  string — The unique identifier of the call.

• call_log_id

  string — The call log ID. <b>Deprecated:</b> This is the legacy call log ID. Zoom will stop producing legacy call log data in a future release, and the associated [Get call log details](https://developers.zoom.us/docs/api/phone/#tag/call-logs/get/phone/call_logs/{callLogId}) API has also been deprecated. As an alternative, use `call_element_id` together with the call element / call history APIs.

• callee_account_code

  string — The callee's account code. To dial between accounts, use the format: [Account code] - [extension number].

• callee_did_number

  string — The callee's DID number.

• caller_account_code

  string — The caller's account code. To dial between accounts, use the format: [Account code] - [extension number].

• caller_did_number

  string — The caller's DID number.

• caller_name

  string — The name of the caller.

• end_time

  string, format: date-time — The recording's end time.

• outgoing_by

  object — The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.

  • extension_number

    string — The user's extension number.

  • name

    string — The user name.

• owner

  object — The owner of the call.

  • id (required)

    string — The owner ID.

  • name (required)

    string — The owner name.

  • type (required)

    string — The owner type. This value field can be `user` or `callQueue`.

  • extension_number

    integer — The extension number of the owner

  • has_access_permission

    boolean — Whether the owner has the access permission to this recording.

• recording_type

  string — The recording type of the call. This value field can be `OnDemand` or `Automatic`.

• site

  object — The site of the call.

  • id

    string — The site ID of the call.

• user_id

  string — The unique identifier of the user.

• fax_log_id (required)

  string — The unique fax log ID.

• download_url (required)

  string — The URL to download the file.

• file_id (required)

  string — The unique identifier for a media file.

• name (required)

  string — The name of the file.

• size (required)

  integer — The size of the file in bytes.

• type (required)

  string, possible values: "JPG", "JPEG", "PNG", "GIF", "PDF" — The type of file.

• fax_log_id (required)

  string — The unique fax log ID.

• callee_name (required)

  string — Name of the callee.

• callee_number (required)

  string — Phone number of the callee.

• callee_number_type (required)

  integer, possible values: 1, 2 — Phone number type of the callee. The value can be one of the following: * `1` - internal * `2` - external

• caller_number (required)

  string — Phone number of the caller.

• caller_number_type (required)

  integer, possible values: 1, 2 — Phone number type of the caller. The value can be one of the following: * `1` - internal * `2` - external

• date_time (required)

  string, format: date-time — Start date and time of the call.

• direction (required)

  string, possible values: "inbound", "outbound" — Direction of the call. The value of this field can either be `inbound` or `outbound`.

• id (required)

  string — Recording ID: Unique Identifier of the call recording.

• transcript_download_url (required)

  string — URL using which the call recording transcript can be downloaded. To download the recording transcript via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter. For example, if the value of this field is "https://zoom.us/v2/phone/recording_transcript/download/abcD666T”, the complete URL path to download the recording trancsript will be as below: `https://zoom.us/v2/phone/recording_transcript/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}`

• accepted_by

  object — The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.

  • extension_number

    string — User extension number

  • name

    string — User name

• call_id

  string — Unique identifier of the call.

• call_log_id

  string — Call log id.

• callee_account_code

  string — The callee's account code. To dial between accounts, use the format: [Account code] - [extension number].

• caller_account_code

  string — The caller's account code. To dial between accounts, use the format: [Account code] - [extension number].

• caller_name

  string — Name of the caller.

• duration

  integer — Duration of the call in seconds.

• end_time

  string, format: date-time — The recording's end time.

• outgoing_by

  object — The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.

  • extension_number

    string — User extension number

  • name

    string — User name

• owner

  object — Owner of the call.

  • id (required)

    string — Owner id.

  • name (required)

    string — Owner name.

  • type (required)

    string — Owner type. This value field can be `user` or `callQueue`.

  • extension_number

    integer — Extension number of the owner

• recording_type

  string — Recording type of the call. This value field can be `OnDemand` or `Automatic`.

• site

  object — Site of the call.

  • id (required)

    string — Site ID of the call.

• user_id

  string — Unique identifier of the user.

• call_id (required)

  string — The unique identifier of the call.

• id (required)

  string — The unique identifier of the call log.

• download_url (required)

  string — The URL using which the file can be downloaded.

• id (required)

  string — The unique identifier for a media file.

• name (required)

  string — The name of the file.

• size (required)

  integer — The size of the file in bytes.

• type (required)

  string — The type of file.

• phone_number (required)

  string — The SMS receiver's phone number.

• display_name

  string — The SMS receiver's display name.

• id

  string — The SMS receiver's ID.

• type

  string, possible values: "user", "callQueue", "autoReceptionist" — The type of receiver: *`user` *`callQueue` *`autoReceptionist`.

• consumer_phone_number (required)

  string — The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.

• opt_status (required)

  string, possible values: "pending", "opt_out", "opt_in" — The opt status.

• zoom_phone_user_number (required)

  string — The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.

• opt_in_message

  string — If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.

• opt_in_status

  integer, possible values: 0, 1, 2, 3, 4 — The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of `opt_status` and uses the following enumeration: 0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons. 1: This is a new SMS session and an Opt-In message must be sent first. 2: An Opt-In message has been sent and a response is pending. 3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages. 4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.

• id (required)

  string — The unique identifier of the voice mail.

• call_id (required)

  string — The call ID.

• id (required)

  string — The recording ID.

• consumer_phone_number (required)

  string — The end user's phone number in E164 format that sends the Opt-out keyword to the Zoom Phone number.

• zoom_phone_user_number (required)

  string — Zoom user's phone number in E164 format that receives the Opt-out keyword from the end user.

• call_id (required)

  string — The ID of the phone call.

• call_path_id (required)

  string — The call path ID of the call.

• id (required)

  string — The ID of the call history.

• result (required)

  string, possible values: "answered", "accepted", "picked_up", "connected", "succeeded", "voicemail", "hang_up", "canceled", "call_failed", "unconnected", "rejected", "busy", "ring_timeout", "overflowed", "no_answer", "invalid_key", "invalid_operation", "abandoned", "system_blocked", "service_unavailable" — The detail result of an event for a call log.

• start_time (required)

  string — The call start time in GMT `date-time` format.

• answer_time

  string — The call answer time in GMT `date-time` format.

• call_type

  string, possible values: "general", "emergency" — The type of call.

• callee_account_code

  string — The callee's account code. To dial between accounts, use the format: [Account code] - [extension number].

• callee_cost_center

  string — The callee's cost center.

• callee_country_code

  string — The callee's country code.

• callee_country_iso_code

  string — The callee's country ISO code.

• callee_department

  string — The callee's department.

• callee_device_private_ip

  string — The callee's private IP.

• callee_device_public_ip

  string — The callee's public IP.

• callee_device_type

  string — The callee's device type.

• callee_did_number

  string — The callee's DID number in e164 format.

• callee_email

  string — The callee's email.

• callee_employee_id

  string — Ther callee's employee id

• callee_ext_id

  string — The callee's extension ID.

• callee_ext_number

  string — The extension number of the callee.

• callee_ext_type

  string, possible values: "user", "call_queue", "auto_receptionist", "common_area", "zoom_room", "cisco_room", "shared_line_group", "group_call_pickup", "external_contact" — The callee's extension type.

• callee_name

  string — The name of the callee.

• callee_number_type

  string, possible values: "zoom_pstn", "zoom_toll_free_number", "external_pstn", "external_contact", "byoc", "byop", "3rd_party_contact_center", "zoom_service_number", "external_service_number", "zoom_contact_center", "meeting_phone_number", "meeting_id", "anonymous_number" — The callee's number type.

• callee_site_id

  string — The callee's site ID.

• caller_account_code

  string — The caller's account code. To dial between accounts, use the format: [Account code] - [extension number].

• caller_cost_center

  string — The caller's cost center.

• caller_country_code

  string — The caller's country code.

• caller_country_iso_code

  string — The caller's country ISO code.

• caller_department

  string — The caller's department.

• caller_device_private_ip

  string — The caller's private IP.

• caller_device_public_ip

  string — The caller's public IP.

• caller_device_type

  string — The caller's device type.

• caller_did_number

  string — The caller's DID number in e164 format.

• caller_email

  string — The caller's email.

• caller_employee_id

  string — Ther caller's employee id

• caller_ext_id

  string — The caller's extension ID.

• caller_ext_number

  string — The extension number of the caller.

• caller_ext_type

  string, possible values: "user", "call_queue", "auto_receptionist", "common_area", "zoom_room", "cisco_room", "shared_line_group", "group_call_pickup", "external_contact" — The caller's extension type.

• caller_name

  string — The name of the caller.

• caller_number_type

  string, possible values: "zoom_pstn", "zoom_toll_free_number", "external_pstn", "external_contact", "byoc", "byop", "3rd_party_contact_center", "zoom_service_number", "external_service_number", "zoom_contact_center", "meeting_phone_number", "meeting_id", "anonymous_number" — The caller's number type.

• caller_site_id

  string — The caller's site ID.

• connect_type

  string, possible values: "internal", "external" — The connect type of call.

• direction

  string, possible values: "inbound", "outbound" — The direction of the call.

• end_time

  string — The call end time in GMT `date-time` format.

• end_to_end

  boolean — A flag to indicate the call is End-to-End Encryption or not.

• event

  string, possible values: "incoming", "transfer_from_zoom_contact_center", "shared_line_incoming", "outgoing", "call_me_on", "outgoing_to_zoom_contact_center", "warm_transfer", "forward", "ring_to_member", "overflow", "direct_transfer", "barge", "monitor", "whisper", "listen", "takeover", "conference_barge", "park", "timeout", "park_pick_up", "merge", "shared" — An event within a call log.

• group_id

  string — The primary group of which the user belongs.

• hide_caller_id

  boolean — A flag to indicate the call is hide caller ID or not.

• hold_time

  integer — The call hold time in seconds.

• operator_ext_id

  string — The operator extension ID.

• operator_ext_number

  string — The operator extension number.

• operator_ext_type

  string, possible values: "user", "call_queue", "auto_receptionist", "common_area", "zoom_room", "cisco_room", "shared_line_group", "group_call_pickup", "external_contact" — The operator extension type.

• operator_name

  string — The operator's name.

• recording_id

  string — The unique identifier of the call recording.

• recording_type

  string, possible values: "ad-hoc", "automatic" — The type of call recording.

• result_reason

  string, possible values: "answered_by_other", "pickup_by_other", "call_out_by_other" — The reason of result of an event for a call log.

• talk_time

  integer — The call talk time in seconds.

• voicemail_id

  string — The ID of the call voicemail.

• wait_time

  integer — The call wait time in seconds.

string

• id (required)

  string — The unique identifier of the voice mail.

• consumer_phone_number (required)

  string — End user's phone number in E164 format that sends the Opt-in keyword to the Zoom Phone number.

• zoom_phone_user_number (required)

  string — Zoom user's phone number in E164 format that receives Opt-in keyword from the end user.

• call_element_id (required)

  string — The ID of the call element.

• call_history_uuid (required)

  string — The call history ID of the call.

• call_id (required)

  string — The ID of the phone call.

• result (required)

  string, possible values: "answered", "accepted", "picked_up", "connected", "succeeded", "voicemail", "hang_up", "canceled", "call_failed", "unconnected", "rejected", "busy", "ring_timeout", "overflowed", "no_answer", "invalid_key", "invalid_operation", "abandoned", "system_blocked", "service_unavailable" — The detail result of an event for a call log.

• start_time (required)

  string — The call start time in GMT `date-time` format.

• answer_time

  string — The call answer time in GMT `date-time` format.

• call_type

  string, possible values: "general", "emergency" — The type of call.

• callee_cost_center

  string — The callee's cost center.

• callee_country_code

  string — The callee's country code.

• callee_country_iso_code

  string — The callee's country ISO code.

• callee_department

  string — The callee's department.

• callee_device_private_ip

  string — The callee's private IP.

• callee_device_public_ip

  string — The callee's public IP.

• callee_device_type

  string — The callee's device type.

• callee_did_number

  string — The callee's DID number in e164 format.

• callee_email

  string — The callee's email.

• callee_employee_id

  string — Ther callee's employee id

• callee_ext_id

  string — The callee's extension ID.

• callee_ext_number

  string — The extension number of the callee.

• callee_ext_type

  string, possible values: "user", "call_queue", "auto_receptionist", "common_area", "zoom_room", "cisco_room", "shared_line_group", "group_call_pickup", "external_contact" — The callee's extension type.

• callee_name

  string — The name of the callee.

• callee_number_type

  string, possible values: "zoom_pstn", "zoom_toll_free_number", "external_pstn", "external_contact", "byoc", "byop", "3rd_party_contact_center", "zoom_service_number", "external_service_number", "zoom_contact_center", "meeting_phone_number", "meeting_id", "anonymous_number" — The callee's number type.

• callee_site_id

  string — The callee's site ID.

• caller_cost_center

  string — The caller's cost center.

• caller_country_code

  string — The caller's country code.

• caller_country_iso_code

  string — The caller's country ISO code.

• caller_department

  string — The caller's department.

• caller_device_private_ip

  string — The caller's private IP.

• caller_device_public_ip

  string — The caller's public IP.

• caller_device_type

  string — The caller's device type.

• caller_did_number

  string — The caller's DID number in e164 format.

• caller_email

  string — The caller's email.

• caller_employee_id

  string — Ther caller's employee id

• caller_ext_id

  string — The caller's extension ID.

• caller_ext_number

  string — The extension number of the caller.

• caller_ext_type

  string, possible values: "user", "call_queue", "auto_receptionist", "common_area", "zoom_room", "cisco_room", "shared_line_group", "group_call_pickup", "external_contact" — The caller's extension type.

• caller_name

  string — The name of the caller.

• caller_number_type

  string, possible values: "zoom_pstn", "zoom_toll_free_number", "external_pstn", "external_contact", "byoc", "byop", "3rd_party_contact_center", "zoom_service_number", "external_service_number", "zoom_contact_center", "meeting_phone_number", "meeting_id", "anonymous_number" — The caller's number type.

• caller_site_id

  string — The caller's site ID.

• connect_type

  string, possible values: "internal", "external" — The connect type of call.

• direction

  string, possible values: "inbound", "outbound" — The direction of the call.

• end_time

  string — The call end time in GMT `date-time` format.

• end_to_end

  boolean — A flag to indicate the call is End-to-End Encryption or not.

• event

  string, possible values: "incoming", "transfer_from_zoom_contact_center", "shared_line_incoming", "outgoing", "call_me_on", "outgoing_to_zoom_contact_center", "warm_transfer", "forward", "ring_to_member", "overflow", "direct_transfer", "barge", "monitor", "whisper", "listen", "takeover", "conference_barge", "park", "timeout", "park_pick_up", "merge", "shared" — An event within a call log.

• group_id

  string — The primary group of which the user belongs.

• handler_ext_id

  string — The handler extension id, when the result reason is `answer_by_other`, `pick_up_by_other` or `call_out_by_other`.

• handler_ext_number

  string — The handler extension number, when the result reason is `answer_by_other`, `pick_up_by_other` or `call_out_by_other`.

• handler_ext_type

  string, possible values: "user", "common_area", "zoom_room", "cisco_room" — The handler extension type, when the result reason is `answer_by_other`, `pick_up_by_other` or `call_out_by_other`.

• handler_name

  string — The handler's name, when the result reason is `answer_by_other`, `pick_up_by_other` or `call_out_by_other`.

• hide_caller_id

  boolean — A flag to indicate the call is hide caller ID or not.

• hold_time

  integer — The call hold time in seconds.

• operator_ext_id

  string — The operator extension ID.

• operator_ext_number

  string — The operator extension number.

• operator_ext_type

  string, possible values: "user", "call_queue", "auto_receptionist", "common_area", "zoom_room", "cisco_room", "shared_line_group", "group_call_pickup", "external_contact" — The operator extension type.

• operator_name

  string — The operator's name.

• recording_id

  string — The unique identifier of the call recording.

• recording_type

  string, possible values: "ad-hoc", "automatic" — The type of call recording.

• result_reason

  string, possible values: "answered_by_other", "pickup_by_other", "call_out_by_other" — The reason of result of an event for a call log.

• talk_time

  integer — The call talk time in seconds.

• voicemail_id

  string — The ID of the call voicemail.

• wait_time

  integer — The call wait time in seconds.

string

• call_id (required)

  string — The unique identifier of the call.

• id (required)

  string — The unique identifier of the call log.

• callee_name (required)

  string — The name of the callee.

• callee_number (required)

  string — The phone number of the callee.

• callee_number_type (required)

  integer, possible values: 1, 2 — The phone number type of the callee. The value can be one of the following: * `1` - internal * `2` - external

• caller_number (required)

  string — The phone number of the caller.

• caller_number_type (required)

  integer, possible values: 1, 2 — The phone number type of the caller. The value can be one of the following: * `1` - internal * `2` - external

• date_time (required)

  string, format: date-time — The start date and time of the call.

• direction (required)

  string, possible values: "inbound", "outbound" — The direction of the call. The value of this field can either be `inbound` or `outbound`.

• download_url (required)

  string — The URL to download the call recording. To download the recording via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter. For example, if the value of this field is "https://zoom.us/v2/phone/recording/download/abcD666T”, the complete URL path to download the recording will be as below: `https://zoom.us/v2/phone/recording/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}`

• duration (required)

  integer — The duration of the call in seconds.

• id (required)

  string — The recording ID is the unique Identifier of the call recording.

• accepted_by

  object — The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.

  • extension_number

    string — The user's extension number.

  • name

    string — The user's name

• call_element_id

  string — The call element ID.

• call_history_id

  string — Use `call_element_id` instead. The call history ID.

• call_id

  string — The unique identifier of the call.

• call_log_id

  string — The call log ID. <b>Deprecated:</b> This is the legacy call log ID. Zoom will stop producing legacy call log data in a future release, and the associated [Get call log details](https://developers.zoom.us/docs/api/phone/#tag/call-logs/get/phone/call_logs/{callLogId}) API has also been deprecated. As an alternative, use `call_element_id` together with the call element / call history APIs.

• callee_account_code

  string — The callee's account code. To dial between accounts, use the format: [Account code] - [extension number].

• callee_did_number

  string — The callee's DID number.

• caller_account_code

  string — The caller's account code. To dial between accounts, use the format: [Account code] - [extension number].

• caller_did_number

  string — The caller's DID number.

• caller_name

  string — The name of the caller.

• end_time

  string, format: date-time — The recording's end time.

• outgoing_by

  object — The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.

  • extension_number

    string — The user's extension number.

  • name

    string — The user's name.

• owner

  object — The owner of the call.

  • id (required)

    string — The owner's ID.

  • name (required)

    string — The owner's name.

  • type (required)

    string — The owner's type. This value field can be `user` or `callQueue`.

  • extension_number

    integer — The extension number of the owner

  • has_access_permission

    boolean — Whether the owner has the access permission to this recording.

• recording_type

  string — The recording type of the call. This value field can be `OnDemand` or `Automatic`.

• site

  object — The site of the call.

  • id

    string — The site ID of the call.

• user_id

  string — The unique identifier of the user.