Phone

• OpenAPI Version: 3.1.0
• API Version: 1.0.0

The Zoom Phone webhooks allow developers to receive events for Zoom Phone features.

Operations

POST phone.recording_deleted

• Method: POST
• Path: phone.recording_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The ID of the account to which the recording belongs.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • call_id (required)

        string — The call ID.

      • id (required)

        string — The recording ID.

Example:

{
  "event": "phone.recording_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "call_id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The ID of the account to which the recording belongs.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • call_id (required)

        string — The call ID.

      • id (required)

        string — The recording ID.

Example:

{
  "event": "phone.recording_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "call_id": ""
        }
      ]
    }
  }
}

POST phone.caller_call_log_completed

• Method: POST
• Path: phone.caller_call_log_completed
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.caller_call_log_completed" — Event name.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the caller.

  • object (required)

    object

    • call_logs (required)

      array

      Items:

      • 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.

    • user_id (required)

      string — User Id of the caller.

Example:

{
  "event": "phone.caller_call_log_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "call_logs": [
        {
          "id": "",
          "caller_number": "",
          "caller_number_type": 1,
          "caller_number_source": "internal",
          "caller_name": "",
          "caller_location": "",
          "caller_did_number": "",
          "caller_country_code": "",
          "caller_country_iso_code": "",
          "callee_number": "",
          "callee_number_type": 1,
          "callee_number_source": "internal",
          "callee_name": "",
          "callee_location": "",
          "callee_did_number": "",
          "callee_country_code": "",
          "callee_country_iso_code": "",
          "duration": 1,
          "result": "",
          "date_time": "",
          "path": "",
          "site": {
            "id": ""
          },
          "has_recording": true,
          "recording_id": "",
          "recording_type": "",
          "has_voicemail": true,
          "call_id": "",
          "client_code": "",
          "call_type": "voip",
          "call_end_time": "",
          "direction": "inbound",
          "forwarded_to": {
            "extension_number": "",
            "extension_type": "user",
            "location": "",
            "name": "",
            "number_type": 1,
            "phone_number": ""
          },
          "forwarded_by": {
            "extension_number": "",
            "extension_type": "user",
            "location": "",
            "name": "",
            "number_type": 1,
            "phone_number": ""
          },
          "hold_time": 1,
          "department": "",
          "cost_center": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.caller_call_log_completed" — Event name.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the caller.

  • object (required)

    object

    • call_logs (required)

      array

      Items:

      • 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.

    • user_id (required)

      string — User Id of the caller.

Example:

{
  "event": "phone.caller_call_log_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "call_logs": [
        {
          "id": "",
          "caller_number": "",
          "caller_number_type": 1,
          "caller_number_source": "internal",
          "caller_name": "",
          "caller_location": "",
          "caller_did_number": "",
          "caller_country_code": "",
          "caller_country_iso_code": "",
          "callee_number": "",
          "callee_number_type": 1,
          "callee_number_source": "internal",
          "callee_name": "",
          "callee_location": "",
          "callee_did_number": "",
          "callee_country_code": "",
          "callee_country_iso_code": "",
          "duration": 1,
          "result": "",
          "date_time": "",
          "path": "",
          "site": {
            "id": ""
          },
          "has_recording": true,
          "recording_id": "",
          "recording_type": "",
          "has_voicemail": true,
          "call_id": "",
          "client_code": "",
          "call_type": "voip",
          "call_end_time": "",
          "direction": "inbound",
          "forwarded_to": {
            "extension_number": "",
            "extension_type": "user",
            "location": "",
            "name": "",
            "number_type": 1,
            "phone_number": ""
          },
          "forwarded_by": {
            "extension_number": "",
            "extension_type": "user",
            "location": "",
            "name": "",
            "number_type": 1,
            "phone_number": ""
          },
          "hold_time": 1,
          "department": "",
          "cost_center": ""
        }
      ]
    }
  }
}

POST phone.recording_completed_for_access_member

• Method: POST
• Path: phone.recording_completed_for_access_member
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_completed_for_access_member" — Event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who recorded the call.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • 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 — The call history id.

      • call_id

        string — The unique identifier of the call.

      • call_log_id

        string — The call log id.

      • 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.

Example:

{
  "event": "phone.recording_completed_for_access_member",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "caller_account_code": "",
          "caller_number": "",
          "caller_number_type": 1,
          "caller_name": "",
          "caller_did_number": "",
          "callee_account_code": "",
          "callee_number": "",
          "callee_number_type": 1,
          "callee_name": "",
          "callee_did_number": "",
          "duration": 1,
          "download_url": "",
          "date_time": "",
          "user_id": "",
          "call_id": "",
          "call_log_id": "",
          "call_element_id": "",
          "end_time": "",
          "recording_type": "",
          "site": {
            "id": ""
          },
          "owner": {
            "type": "",
            "id": "",
            "name": "",
            "extension_number": 1,
            "has_access_permission": true
          },
          "direction": "inbound",
          "outgoing_by": {
            "name": "",
            "extension_number": ""
          },
          "accepted_by": {
            "name": "",
            "extension_number": ""
          }
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_completed_for_access_member" — Event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who recorded the call.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • 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 — The call history id.

      • call_id

        string — The unique identifier of the call.

      • call_log_id

        string — The call log id.

      • 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.

Example:

{
  "event": "phone.recording_completed_for_access_member",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "caller_account_code": "",
          "caller_number": "",
          "caller_number_type": 1,
          "caller_name": "",
          "caller_did_number": "",
          "callee_account_code": "",
          "callee_number": "",
          "callee_number_type": 1,
          "callee_name": "",
          "callee_did_number": "",
          "duration": 1,
          "download_url": "",
          "date_time": "",
          "user_id": "",
          "call_id": "",
          "call_log_id": "",
          "call_element_id": "",
          "end_time": "",
          "recording_type": "",
          "site": {
            "id": ""
          },
          "owner": {
            "type": "",
            "id": "",
            "name": "",
            "extension_number": 1,
            "has_access_permission": true
          },
          "direction": "inbound",
          "outgoing_by": {
            "name": "",
            "extension_number": ""
          },
          "accepted_by": {
            "name": "",
            "extension_number": ""
          }
        }
      ]
    }
  }
}

POST phone.recording_resumed

• Method: POST
• Path: phone.recording_resumed
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — Name of the event.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user.

  • object (required)

    object

    • call_id (required)

      string — Unique identifier of the call.

    • callee_number (required)

      string — Phone number or the extension number of the callee.

    • caller_number (required)

      string — Phone number or the extension number of the caller.

    • date_time (required)

      string, format: date-time — The time and date when the recording has resumed.

    • direction (required)

      string, possible values: "inbound", "outbound" — Direction of the call: inbound or outbound.

    • id (required)

      string — The recording ID.

    • owner (required)

      object — The owner of the recording.

      • extension_number (required)

        integer — Extension number of the owner

      • id (required)

        string — The owner ID.

      • name (required)

        string — Display name of the owner.

      • type (required)

        string, possible values: "user", "callQueue", "commonArea" — The owner type: user or callQueue.

    • recording_type (required)

      string, possible values: "OnDemand", "Automatic" — The type of the recording: OnDemand or Automatic.

    • user_id (required)

      string — The user 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].

Example:

{
  "event": "",
  "payload": {
    "account_id": "",
    "object": {
      "id": "",
      "user_id": "",
      "caller_account_code": "",
      "caller_number": "",
      "callee_account_code": "",
      "callee_number": "",
      "direction": "inbound",
      "date_time": "",
      "recording_type": "OnDemand",
      "call_id": "",
      "owner": {
        "type": "user",
        "id": "",
        "name": "",
        "extension_number": 1,
        "additionalProperty": "anything"
      },
      "additionalProperty": "anything"
    }
  },
  "event_ts": 1
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — Name of the event.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user.

  • object (required)

    object

    • call_id (required)

      string — Unique identifier of the call.

    • callee_number (required)

      string — Phone number or the extension number of the callee.

    • caller_number (required)

      string — Phone number or the extension number of the caller.

    • date_time (required)

      string, format: date-time — The time and date when the recording has resumed.

    • direction (required)

      string, possible values: "inbound", "outbound" — Direction of the call: inbound or outbound.

    • id (required)

      string — The recording ID.

    • owner (required)

      object — The owner of the recording.

      • extension_number (required)

        integer — Extension number of the owner

      • id (required)

        string — The owner ID.

      • name (required)

        string — Display name of the owner.

      • type (required)

        string, possible values: "user", "callQueue", "commonArea" — The owner type: user or callQueue.

    • recording_type (required)

      string, possible values: "OnDemand", "Automatic" — The type of the recording: OnDemand or Automatic.

    • user_id (required)

      string — The user 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].

Example:

{
  "event": "",
  "payload": {
    "account_id": "",
    "object": {
      "id": "",
      "user_id": "",
      "caller_account_code": "",
      "caller_number": "",
      "callee_account_code": "",
      "callee_number": "",
      "direction": "inbound",
      "date_time": "",
      "recording_type": "OnDemand",
      "call_id": "",
      "owner": {
        "type": "user",
        "id": "",
        "name": "",
        "extension_number": 1,
        "additionalProperty": "anything"
      },
      "additionalProperty": "anything"
    }
  },
  "event_ts": 1
}

POST phone.fax_log_deleted

• Method: POST
• Path: phone.fax_log_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.fax_log_deleted" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The owner account ID.

  • object (required)

    object — object

    • fax_logs (required)

      array — The deleted fax logs information.

      Items:

      • fax_log_id (required)

        string — The unique fax log ID.

Example:

{
  "event": "phone.fax_log_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "fax_logs": [
        {
          "fax_log_id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.fax_log_deleted" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The owner account ID.

  • object (required)

    object — object

    • fax_logs (required)

      array — The deleted fax logs information.

      Items:

      • fax_log_id (required)

        string — The unique fax log ID.

Example:

{
  "event": "phone.fax_log_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "fax_logs": [
        {
          "fax_log_id": ""
        }
      ]
    }
  }
}

POST phone.fax_log_permanently_deleted

• Method: POST
• Path: phone.fax_log_permanently_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.fax_log_permanently_deleted" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The owner account ID.

  • object (required)

    object — object

    • fax_logs (required)

      array — The list of permanently deleted fax logs.

      Items:

      • fax_log_id (required)

        string — The unique fax log ID.

Example:

{
  "event": "phone.fax_log_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "fax_logs": [
        {
          "fax_log_id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.fax_log_permanently_deleted" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The owner account ID.

  • object (required)

    object — object

    • fax_logs (required)

      array — The list of permanently deleted fax logs.

      Items:

      • fax_log_id (required)

        string — The unique fax log ID.

Example:

{
  "event": "phone.fax_log_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "fax_logs": [
        {
          "fax_log_id": ""
        }
      ]
    }
  }
}

POST phone.transfer_recipient_updated

• Method: POST
• Path: phone.transfer_recipient_updated
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp in milliseconds since epoch when the event occurred, in int64 format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user.

  • object (required)

    object

    • call_id (required)

      string — The unique identifier for the call.

    • date_time (required)

      string — The date and time (GMT) when the recipient of the warm/blind transfer call was updated, in yyyy-MM-dd'T'HH:mm:ss'Z' format.

    • recipient (required)

      object — The recipient who received the warm/blind transfer call from the event owner.

      • extension_number

        integer, format: int64 — The recipient's extension number.

      • name

        string — The name of the recipient.

      • phone_number

        string — The phone number of the recipient in E164 format.

    • failure_reason

      string — The reason why the recipient update for the warm/blind transfer call failed. An empty string indicates success.

    • owner

      object — The owner of this event.

      • extension_number

        integer, format: int64 — The owner's extension number.

      • id

        string — The unique identifier for the owner.

      • name

        string — The name of the owner.

      • type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the owner.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "failure_reason": "",
      "call_id": "",
      "owner": {
        "extension_number": "1001019",
        "id": "z8yCxjabcdEFGHfp8uQ",
        "name": "Tom Jones",
        "type": "user"
      },
      "recipient": {
        "extension_number": "1001020",
        "phone_number": "+12192818492",
        "name": "Jane Smith"
      },
      "date_time": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp in milliseconds since epoch when the event occurred, in int64 format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user.

  • object (required)

    object

    • call_id (required)

      string — The unique identifier for the call.

    • date_time (required)

      string — The date and time (GMT) when the recipient of the warm/blind transfer call was updated, in yyyy-MM-dd'T'HH:mm:ss'Z' format.

    • recipient (required)

      object — The recipient who received the warm/blind transfer call from the event owner.

      • extension_number

        integer, format: int64 — The recipient's extension number.

      • name

        string — The name of the recipient.

      • phone_number

        string — The phone number of the recipient in E164 format.

    • failure_reason

      string — The reason why the recipient update for the warm/blind transfer call failed. An empty string indicates success.

    • owner

      object — The owner of this event.

      • extension_number

        integer, format: int64 — The owner's extension number.

      • id

        string — The unique identifier for the owner.

      • name

        string — The name of the owner.

      • type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the owner.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "failure_reason": "",
      "call_id": "",
      "owner": {
        "extension_number": "1001019",
        "id": "z8yCxjabcdEFGHfp8uQ",
        "name": "Tom Jones",
        "type": "user"
      },
      "recipient": {
        "extension_number": "1001020",
        "phone_number": "+12192818492",
        "name": "Jane Smith"
      },
      "date_time": ""
    }
  }
}

POST phone.recording_transcript_completed

• Method: POST
• Path: phone.recording_transcript_completed
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_transcript_completed" — Event name.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the user who recorded the call.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • 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.

Example:

{
  "event": "phone.recording_transcript_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "caller_account_code": "",
          "caller_number": "",
          "caller_number_type": 1,
          "caller_name": "",
          "callee_account_code": "",
          "callee_number": "",
          "callee_number_type": 1,
          "callee_name": "",
          "duration": 1,
          "transcript_download_url": "",
          "date_time": "",
          "user_id": "",
          "call_id": "",
          "call_log_id": "",
          "end_time": "",
          "recording_type": "",
          "site": {
            "id": ""
          },
          "owner": {
            "type": "",
            "id": "",
            "name": "",
            "extension_number": 1
          },
          "direction": "inbound",
          "outgoing_by": {
            "name": "",
            "extension_number": ""
          },
          "accepted_by": {
            "name": "",
            "extension_number": ""
          }
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_transcript_completed" — Event name.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the user who recorded the call.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • 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.

Example:

{
  "event": "phone.recording_transcript_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "caller_account_code": "",
          "caller_number": "",
          "caller_number_type": 1,
          "caller_name": "",
          "callee_account_code": "",
          "callee_number": "",
          "callee_number_type": 1,
          "callee_name": "",
          "duration": 1,
          "transcript_download_url": "",
          "date_time": "",
          "user_id": "",
          "call_id": "",
          "call_log_id": "",
          "end_time": "",
          "recording_type": "",
          "site": {
            "id": ""
          },
          "owner": {
            "type": "",
            "id": "",
            "name": "",
            "extension_number": 1
          },
          "direction": "inbound",
          "outgoing_by": {
            "name": "",
            "extension_number": ""
          },
          "accepted_by": {
            "name": "",
            "extension_number": ""
          }
        }
      ]
    }
  }
}

POST phone.call_log_permanently_deleted

• Method: POST
• Path: phone.call_log_permanently_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.call_log_permanently_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the call log.

  • object (required)

    object

    • call_logs (required)

      array

      Items:

      • call_id (required)

        string — The unique identifier of the call.

      • id (required)

        string — The unique identifier of the call log.

    • user_id (required)

      string — The user ID of the call log owner.

Example:

{
  "event": "phone.call_log_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "call_logs": [
        {
          "id": "",
          "call_id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.call_log_permanently_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the call log.

  • object (required)

    object

    • call_logs (required)

      array

      Items:

      • call_id (required)

        string — The unique identifier of the call.

      • id (required)

        string — The unique identifier of the call log.

    • user_id (required)

      string — The user ID of the call log owner.

Example:

{
  "event": "phone.call_log_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "call_logs": [
        {
          "id": "",
          "call_id": ""
        }
      ]
    }
  }
}

POST phone.transfer_call_to_voicemail_initiated

• Method: POST
• Path: phone.transfer_call_to_voicemail_initiated
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.transfer_call_to_voicemail_initiated" — The name of the event.

• event_ts (required)

  integer, format: int64 — The long (int64) format timestamp in milliseconds since epoch when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user.

  • object (required)

    object

    • call_id (required)

      string — The call's unique ID.

    • date_time (required)

      string — The date and time (GMT) at which the transfer call to voicemail was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format.

    • transfer_phone_number (required)

      string — The phone number required for the transfer call to voicemail. It may be the user's phone number, extension number or the user's phone number that displays in E164 format.

    • failure_reason

      string — The failure reason for transfer call to voicemail. If it is an empty string, it means success.

    • owner

      object

      • extension_number

        integer — The owner's extension number.

      • id

        string — The owner ID.

      • name

        string — The owner name.

      • type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonAreaPhone", "sharedLineGroup" — The owner type: *user *callQueue *autoReceptionist *commonAreaPhone *sharedLineGroup

    • transfer_account_code

      string — The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number].

Example:

{
  "event": "phone.transfer_call_to_voicemail_initiated",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "failure_reason": "",
      "call_id": "",
      "transfer_account_code": "",
      "transfer_phone_number": "",
      "owner": {
        "extension_number": "1000001019",
        "id": "N3hAhug-QVyFPYZJrHpRaQ",
        "name": "123@test.com",
        "type": "user"
      },
      "date_time": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.transfer_call_to_voicemail_initiated" — The name of the event.

• event_ts (required)

  integer, format: int64 — The long (int64) format timestamp in milliseconds since epoch when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user.

  • object (required)

    object

    • call_id (required)

      string — The call's unique ID.

    • date_time (required)

      string — The date and time (GMT) at which the transfer call to voicemail was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format.

    • transfer_phone_number (required)

      string — The phone number required for the transfer call to voicemail. It may be the user's phone number, extension number or the user's phone number that displays in E164 format.

    • failure_reason

      string — The failure reason for transfer call to voicemail. If it is an empty string, it means success.

    • owner

      object

      • extension_number

        integer — The owner's extension number.

      • id

        string — The owner ID.

      • name

        string — The owner name.

      • type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonAreaPhone", "sharedLineGroup" — The owner type: *user *callQueue *autoReceptionist *commonAreaPhone *sharedLineGroup

    • transfer_account_code

      string — The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number].

Example:

{
  "event": "phone.transfer_call_to_voicemail_initiated",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "failure_reason": "",
      "call_id": "",
      "transfer_account_code": "",
      "transfer_phone_number": "",
      "owner": {
        "extension_number": "1000001019",
        "id": "N3hAhug-QVyFPYZJrHpRaQ",
        "name": "123@test.com",
        "type": "user"
      },
      "date_time": ""
    }
  }
}

POST phone.callee_missed

• Method: POST
• Path: phone.callee_missed
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • call_end_time (required)

      string — The GMT time at which the call was ended, in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • call_id (required)

      string — The unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • phone_number (required)

        string — The phone number of the callee in E164 format. Example: +12192818492 Note: phone_number and extension_number can't be empty at the same time.

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — Zoom clients generate an ID when installed on a device. <b>Note:</b> Does not apply to desk phones.

      • extension_id

        string — The extension ID of the callee.

      • extension_number

        integer, format: int64 — The extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the callee.

      • timezone

        string — The timezone of the callee.

      • user_id

        string — The Zoom user ID of the callee.

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • phone_number (required)

        string — The phone number of the caller in E164 format. Example: +12192818492

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — The extension ID of the caller.

      • extension_number

        integer, format: int64 — The extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the caller.

      • timezone

        string — The timezone of the caller.

      • user_id

        string — The Zoom user ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • forwarded_by

      object — The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.

      • extension_number

        string — The extension number the call was forwarded from.

      • extension_type

        string — The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist

      • name

        string — The name of the extension the call was forwarded from.

    • handup_result

      string — The reason the call was missed. Values: No Answer | Busy | Call Cancel

    • redirect_forwarded_by

      object — The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "phone_number": "",
        "user_id": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": "",
      "call_end_time": "",
      "forwarded_by": {
        "name": "",
        "extension_number": "",
        "extension_type": ""
      },
      "redirect_forwarded_by": {},
      "handup_result": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • call_end_time (required)

      string — The GMT time at which the call was ended, in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • call_id (required)

      string — The unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • phone_number (required)

        string — The phone number of the callee in E164 format. Example: +12192818492 Note: phone_number and extension_number can't be empty at the same time.

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — Zoom clients generate an ID when installed on a device. <b>Note:</b> Does not apply to desk phones.

      • extension_id

        string — The extension ID of the callee.

      • extension_number

        integer, format: int64 — The extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the callee.

      • timezone

        string — The timezone of the callee.

      • user_id

        string — The Zoom user ID of the callee.

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • phone_number (required)

        string — The phone number of the caller in E164 format. Example: +12192818492

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — The extension ID of the caller.

      • extension_number

        integer, format: int64 — The extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the caller.

      • timezone

        string — The timezone of the caller.

      • user_id

        string — The Zoom user ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • forwarded_by

      object — The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.

      • extension_number

        string — The extension number the call was forwarded from.

      • extension_type

        string — The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist

      • name

        string — The name of the extension the call was forwarded from.

    • handup_result

      string — The reason the call was missed. Values: No Answer | Busy | Call Cancel

    • redirect_forwarded_by

      object — The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "phone_number": "",
        "user_id": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": "",
      "call_end_time": "",
      "forwarded_by": {
        "name": "",
        "extension_number": "",
        "extension_type": ""
      },
      "redirect_forwarded_by": {},
      "handup_result": ""
    }
  }
}

POST phone.caller_ringing

• Method: POST
• Path: phone.caller_ringing
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — Name of the event.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the caller.

  • object (required)

    object

    • call_id (required)

      string — Unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — Extension ID of the callee.

      • extension_number

        integer, format: int64 — Extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — Extension type of the callee.

      • name

        string — Callee's user name.

      • phone_number

        string — Phone number of the callee in E164 format. Example: +12192818492

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • phone_number (required)

        string — Phone number of the caller in E164 format. Example: +12192818492

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — The device ID.

      • device_name

        string — The name of device on which the Zoom Client is installed.

      • device_type

        string — Device type of the caller.

      • extension_id

        string — Extension ID of the caller.

      • extension_number

        integer, format: int64 — Extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — Extension type of the caller.

      • name

        string — Caller's user name.

      • timezone

        string — Timezone of the caller.

      • user_id

        string — Zoom User ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "name": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "device_type": "",
        "device_name": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "name": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — Name of the event.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the caller.

  • object (required)

    object

    • call_id (required)

      string — Unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — Extension ID of the callee.

      • extension_number

        integer, format: int64 — Extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — Extension type of the callee.

      • name

        string — Callee's user name.

      • phone_number

        string — Phone number of the callee in E164 format. Example: +12192818492

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • phone_number (required)

        string — Phone number of the caller in E164 format. Example: +12192818492

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — The device ID.

      • device_name

        string — The name of device on which the Zoom Client is installed.

      • device_type

        string — Device type of the caller.

      • extension_id

        string — Extension ID of the caller.

      • extension_number

        integer, format: int64 — Extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — Extension type of the caller.

      • name

        string — Caller's user name.

      • timezone

        string — Timezone of the caller.

      • user_id

        string — Zoom User ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "name": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "device_type": "",
        "device_name": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "name": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": ""
    }
  }
}

POST phone.voicemail_received

• Method: POST
• Path: phone.voicemail_received
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_received" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The callee's account ID.

  • object (required)

    object

    • callee_extension_type (required)

      string, possible values: "user", "callQueue", "autoReceptionist", "sharedLineGroup" — The callee's extension type: * user * callQueue * autoReceptionist * shareLineGroup

    • callee_id (required)

      string — The callee's ID. Depending on the type of extension, this value can be one of the following: * For a regular user (user) — callee_id is the same as callee_user_id. * For call queue (callQueue) — callee_id is the same as the call queue group_id value. * For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id. * For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id.

    • callee_name (required)

      string — The callee's name.

    • callee_number (required)

      string — The callee's phone number.

    • callee_number_type (required)

      integer, possible values: 1, 2 — The callee's number type: * 1 — Internal. * 2 — External.

    • caller_name (required)

      string — The caller's name.

    • caller_number (required)

      string — The caller's phone number.

    • caller_number_type (required)

      integer, possible values: 1, 2 — The caller's number type: * 1 — Internal. * 2 — External.

    • date_time (required)

      string, format: date-time — The date and time at which the voicemail was received.

    • download_url (required)

      string, format: url — The URL at which the voicemail can be downloaded.

    • duration (required)

      integer — The duration of the voicemail.

    • id (required)

      string — The voicemail's unique ID.

    • call_element_id

      string — The call element id.

    • call_history_id

      string — The call history id.

    • call_id

      string — The call's unique ID.

    • call_log_id

      string — Unique identifier of the phone call log.

    • callee_account_code

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

    • callee_did_number

      string — Callee's DID number.

    • callee_user_id

      string — The callee's user ID.

    • caller_account_code

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

    • caller_did_number

      string — Caller's DID number.

    • caller_user_id

      string — The caller's user ID. This field will only exist if the caller is a user of this account.

Example:

{
  "event": "phone.voicemail_received",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "id": "",
      "date_time": "",
      "download_url": "",
      "duration": 1,
      "caller_user_id": "",
      "caller_account_code": "",
      "caller_number": "",
      "caller_number_type": 1,
      "caller_name": "",
      "caller_did_number": "",
      "callee_user_id": "",
      "callee_account_code": "",
      "callee_number": "",
      "callee_number_type": 1,
      "callee_name": "",
      "callee_did_number": "",
      "callee_extension_type": "user",
      "callee_id": "",
      "call_log_id": "",
      "call_history_id": "",
      "call_element_id": "",
      "call_id": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_received" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The callee's account ID.

  • object (required)

    object

    • callee_extension_type (required)

      string, possible values: "user", "callQueue", "autoReceptionist", "sharedLineGroup" — The callee's extension type: * user * callQueue * autoReceptionist * shareLineGroup

    • callee_id (required)

      string — The callee's ID. Depending on the type of extension, this value can be one of the following: * For a regular user (user) — callee_id is the same as callee_user_id. * For call queue (callQueue) — callee_id is the same as the call queue group_id value. * For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id. * For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id.

    • callee_name (required)

      string — The callee's name.

    • callee_number (required)

      string — The callee's phone number.

    • callee_number_type (required)

      integer, possible values: 1, 2 — The callee's number type: * 1 — Internal. * 2 — External.

    • caller_name (required)

      string — The caller's name.

    • caller_number (required)

      string — The caller's phone number.

    • caller_number_type (required)

      integer, possible values: 1, 2 — The caller's number type: * 1 — Internal. * 2 — External.

    • date_time (required)

      string, format: date-time — The date and time at which the voicemail was received.

    • download_url (required)

      string, format: url — The URL at which the voicemail can be downloaded.

    • duration (required)

      integer — The duration of the voicemail.

    • id (required)

      string — The voicemail's unique ID.

    • call_element_id

      string — The call element id.

    • call_history_id

      string — The call history id.

    • call_id

      string — The call's unique ID.

    • call_log_id

      string — Unique identifier of the phone call log.

    • callee_account_code

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

    • callee_did_number

      string — Callee's DID number.

    • callee_user_id

      string — The callee's user ID.

    • caller_account_code

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

    • caller_did_number

      string — Caller's DID number.

    • caller_user_id

      string — The caller's user ID. This field will only exist if the caller is a user of this account.

Example:

{
  "event": "phone.voicemail_received",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "id": "",
      "date_time": "",
      "download_url": "",
      "duration": 1,
      "caller_user_id": "",
      "caller_account_code": "",
      "caller_number": "",
      "caller_number_type": 1,
      "caller_name": "",
      "caller_did_number": "",
      "callee_user_id": "",
      "callee_account_code": "",
      "callee_number": "",
      "callee_number_type": 1,
      "callee_name": "",
      "callee_did_number": "",
      "callee_extension_type": "user",
      "callee_id": "",
      "call_log_id": "",
      "call_history_id": "",
      "call_element_id": "",
      "call_id": ""
    }
  }
}

POST phone.sms_sent

• Method: POST
• Path: phone.sms_sent
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.sms_sent" — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the owner.

  • object (required)

    object — The payload of SMS/MMS message that was sent.

    • attachments (required)

      array — The media file information.

      Items:

      • 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.

    • date_time (required)

      string, format: date-time — The date and time at which the SMS was sent.

    • message (required)

      string — The SMS text content.

    • message_id (required)

      string — The SMS message ID.

    • message_type (required)

      integer — The type of messages.

    • owner (required)

      object — The owner of this SMS/MMS.

      • id

        string — The owner ID.

      • sms_sender_user_id

        string — The user ID of the call queue or auto receptionist member who sent the SMS when the owner type is callQueue or autoReceptionist.

      • type

        string, possible values: "user", "callQueue", "autoReceptionist" — The owner type: *user *callQueue *autoReceptionist

    • sender (required)

      object — The SMS sender.

      • phone_number (required)

        string — The SMS sender's phone number.

      • display_name

        string — The SMS sender's display name.

      • id

        string — SMS sender's user ID.

      • type

        string, possible values: "user" — The type of sender: *user.

    • session_id (required)

      string — The SMS session ID.

    • to_members (required)

      array — The SMS receivers.

      Items:

      • 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.

    • failure_reason

      string — The reason for SMS send failure. An empty field means the SMS send was successful.

    • phone_number_campaign_opt_statuses

      array — The list of opt statuses for each number pair.

      Items:

      • 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.

Example:

{
  "event": "phone.sms_sent",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "failure_reason": "",
      "sender": {
        "phone_number": "",
        "id": "",
        "type": "user",
        "display_name": "",
        "additionalProperty": "anything"
      },
      "to_members": [
        {
          "id": "",
          "type": "user",
          "display_name": "",
          "phone_number": "",
          "additionalProperty": "anything"
        }
      ],
      "owner": {
        "type": "user",
        "id": "",
        "sms_sender_user_id": ""
      },
      "message": "",
      "attachments": [
        {
          "id": "",
          "size": 1,
          "name": "",
          "type": "",
          "download_url": "",
          "additionalProperty": "anything"
        }
      ],
      "session_id": "",
      "message_id": "",
      "message_type": 1,
      "date_time": "",
      "phone_number_campaign_opt_statuses": [
        {
          "consumer_phone_number": "+150434XXXXX",
          "zoom_phone_user_number": "+12094XXXXX",
          "opt_status": "opt_out",
          "opt_in_status": 0,
          "opt_in_message": "Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.sms_sent" — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the owner.

  • object (required)

    object — The payload of SMS/MMS message that was sent.

    • attachments (required)

      array — The media file information.

      Items:

      • 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.

    • date_time (required)

      string, format: date-time — The date and time at which the SMS was sent.

    • message (required)

      string — The SMS text content.

    • message_id (required)

      string — The SMS message ID.

    • message_type (required)

      integer — The type of messages.

    • owner (required)

      object — The owner of this SMS/MMS.

      • id

        string — The owner ID.

      • sms_sender_user_id

        string — The user ID of the call queue or auto receptionist member who sent the SMS when the owner type is callQueue or autoReceptionist.

      • type

        string, possible values: "user", "callQueue", "autoReceptionist" — The owner type: *user *callQueue *autoReceptionist

    • sender (required)

      object — The SMS sender.

      • phone_number (required)

        string — The SMS sender's phone number.

      • display_name

        string — The SMS sender's display name.

      • id

        string — SMS sender's user ID.

      • type

        string, possible values: "user" — The type of sender: *user.

    • session_id (required)

      string — The SMS session ID.

    • to_members (required)

      array — The SMS receivers.

      Items:

      • 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.

    • failure_reason

      string — The reason for SMS send failure. An empty field means the SMS send was successful.

    • phone_number_campaign_opt_statuses

      array — The list of opt statuses for each number pair.

      Items:

      • 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.

Example:

{
  "event": "phone.sms_sent",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "failure_reason": "",
      "sender": {
        "phone_number": "",
        "id": "",
        "type": "user",
        "display_name": "",
        "additionalProperty": "anything"
      },
      "to_members": [
        {
          "id": "",
          "type": "user",
          "display_name": "",
          "phone_number": "",
          "additionalProperty": "anything"
        }
      ],
      "owner": {
        "type": "user",
        "id": "",
        "sms_sender_user_id": ""
      },
      "message": "",
      "attachments": [
        {
          "id": "",
          "size": 1,
          "name": "",
          "type": "",
          "download_url": "",
          "additionalProperty": "anything"
        }
      ],
      "session_id": "",
      "message_id": "",
      "message_type": 1,
      "date_time": "",
      "phone_number_campaign_opt_statuses": [
        {
          "consumer_phone_number": "+150434XXXXX",
          "zoom_phone_user_number": "+12094XXXXX",
          "opt_status": "opt_out",
          "opt_in_status": 0,
          "opt_in_message": "Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."
        }
      ]
    }
  }
}

POST phone.voicemail_deleted

• Method: POST
• Path: phone.voicemail_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • voice_mails (required)

      array

      Items:

      • id (required)

        string — The unique identifier of the voice mail.

Example:

{
  "event": "phone.voicemail_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "voice_mails": [
        {
          "id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • voice_mails (required)

      array

      Items:

      • id (required)

        string — The unique identifier of the voice mail.

Example:

{
  "event": "phone.voicemail_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "voice_mails": [
        {
          "id": ""
        }
      ]
    }
  }
}

POST phone.voicemail_transcript_completed

• Method: POST
• Path: phone.voicemail_transcript_completed
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_transcript_completed" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The callee's account ID.

  • object (required)

    object

    • callee_name (required)

      string — The callee's name.

    • callee_number (required)

      string — The callee's phone number.

    • callee_number_type (required)

      integer, possible values: 1, 2 — The callee's number type: * 1 — Internal. * 2 — External.

    • caller_name (required)

      string — The caller's name.

    • caller_number (required)

      string — The caller's phone number.

    • caller_number_type (required)

      integer, possible values: 1, 2 — The caller's number type: * 1 — Internal. * 2 — External.

    • date_time (required)

      string, format: date-time — The date and time at which the voicemail was received.

    • id (required)

      string — The voicemail's unique ID.

    • transcription (required)

      object — Voicemail transcript

      • content (required)

        string — Content of the voicemail transcript

      • status (required)

        integer, possible values: 0, 1, 2, 4, 5, 9, 11, 12, 13, 14, 409, 415, 422, 500, 601, 602, 603, 999 — Status of the voicemail transcript: * 0 — Transcript is not available. * 1 — Transcript is processing. * 2 - Transcript processed successfully * 4 — Transcript is disabled. * 5 — Transcript is enabled. * 9 — Transcript web error. * 11 — Transcript download error. * 12 — Transcript upload error. * 13 — Transcript web database error. * 14 — Transcript BYOS (Bring Your Own Storage) upload error. * 409 — Transcript duplicate processing request error. * 415 — Transcript unsupported media error. * 422 — Transcript is unprocessable. * 500 — Transcript server error. * 601 — Transcript AISense after retry error. * 602 — Transcript AISense upload file error. * 603 — Transcript AISense download file error. * 999 — Transcript AISense error.

    • call_element_id

      string — The call element id.

    • call_history_id

      string — The call history id.

    • call_id

      string — The call's unique ID.

    • call_log_id

      string — Unique identifier of the phone call log.

    • callee_account_code

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

    • callee_extension_type

      string, possible values: "user", "callQueue", "autoReceptionist", "sharedLineGroup" — The callee's extension type: * user * callQueue * autoReceptionist * shareLineGroup

    • callee_id

      string — The callee's ID. Depending on the type of extension, this value can be one of the following: * For a regular user (user) — callee_id is the same as callee_user_id. * For call queue (callQueue) — callee_id is the same as the call queue group_id value. * For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id. * For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id.

    • callee_user_id

      string — The callee's user ID.

    • caller_account_code

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

Example:

{
  "event": "phone.voicemail_transcript_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "id": "",
      "date_time": "",
      "caller_account_code": "",
      "caller_number": "",
      "caller_number_type": 1,
      "caller_name": "",
      "callee_user_id": "",
      "callee_account_code": "",
      "callee_number": "",
      "callee_number_type": 1,
      "callee_name": "",
      "callee_extension_type": "user",
      "callee_id": "",
      "call_log_id": "",
      "call_element_id": "",
      "call_id": "",
      "transcription": {
        "status": 0,
        "content": ""
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_transcript_completed" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The callee's account ID.

  • object (required)

    object

    • callee_name (required)

      string — The callee's name.

    • callee_number (required)

      string — The callee's phone number.

    • callee_number_type (required)

      integer, possible values: 1, 2 — The callee's number type: * 1 — Internal. * 2 — External.

    • caller_name (required)

      string — The caller's name.

    • caller_number (required)

      string — The caller's phone number.

    • caller_number_type (required)

      integer, possible values: 1, 2 — The caller's number type: * 1 — Internal. * 2 — External.

    • date_time (required)

      string, format: date-time — The date and time at which the voicemail was received.

    • id (required)

      string — The voicemail's unique ID.

    • transcription (required)

      object — Voicemail transcript

      • content (required)

        string — Content of the voicemail transcript

      • status (required)

        integer, possible values: 0, 1, 2, 4, 5, 9, 11, 12, 13, 14, 409, 415, 422, 500, 601, 602, 603, 999 — Status of the voicemail transcript: * 0 — Transcript is not available. * 1 — Transcript is processing. * 2 - Transcript processed successfully * 4 — Transcript is disabled. * 5 — Transcript is enabled. * 9 — Transcript web error. * 11 — Transcript download error. * 12 — Transcript upload error. * 13 — Transcript web database error. * 14 — Transcript BYOS (Bring Your Own Storage) upload error. * 409 — Transcript duplicate processing request error. * 415 — Transcript unsupported media error. * 422 — Transcript is unprocessable. * 500 — Transcript server error. * 601 — Transcript AISense after retry error. * 602 — Transcript AISense upload file error. * 603 — Transcript AISense download file error. * 999 — Transcript AISense error.

    • call_element_id

      string — The call element id.

    • call_history_id

      string — The call history id.

    • call_id

      string — The call's unique ID.

    • call_log_id

      string — Unique identifier of the phone call log.

    • callee_account_code

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

    • callee_extension_type

      string, possible values: "user", "callQueue", "autoReceptionist", "sharedLineGroup" — The callee's extension type: * user * callQueue * autoReceptionist * shareLineGroup

    • callee_id

      string — The callee's ID. Depending on the type of extension, this value can be one of the following: * For a regular user (user) — callee_id is the same as callee_user_id. * For call queue (callQueue) — callee_id is the same as the call queue group_id value. * For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id. * For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id.

    • callee_user_id

      string — The callee's user ID.

    • caller_account_code

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

Example:

{
  "event": "phone.voicemail_transcript_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "id": "",
      "date_time": "",
      "caller_account_code": "",
      "caller_number": "",
      "caller_number_type": 1,
      "caller_name": "",
      "callee_user_id": "",
      "callee_account_code": "",
      "callee_number": "",
      "callee_number_type": 1,
      "callee_name": "",
      "callee_extension_type": "user",
      "callee_id": "",
      "call_log_id": "",
      "call_element_id": "",
      "call_id": "",
      "transcription": {
        "status": 0,
        "content": ""
      }
    }
  }
}

POST phone.recording_permanently_deleted

• Method: POST
• Path: phone.recording_permanently_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_permanently_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The ID of the account to which the recording belongs.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • call_id (required)

        string — The call ID.

      • id (required)

        string — The recording ID.

Example:

{
  "event": "phone.recording_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "call_id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.recording_permanently_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The ID of the account to which the recording belongs.

  • object (required)

    object

    • recordings (required)

      array

      Items:

      • call_id (required)

        string — The call ID.

      • id (required)

        string — The recording ID.

Example:

{
  "event": "phone.recording_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "recordings": [
        {
          "id": "",
          "call_id": ""
        }
      ]
    }
  }
}

POST phone.peering_number_emergency_address_updated

• Method: POST
• Path: phone.peering_number_emergency_address_updated
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — Name of the event.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the customer using provider exchange.

  • object (required)

    object

    • carrier_code (required)

      integer — The carrier code.

    • phone_numbers (required)

      array — The phone numbers with emergency address updates.

    • emergency_address

      object — The emergency address info.

      • address_line1 (required)

        string — Emergency address(house number and street name).

      • address_line2

        string — Additional emergency address information (building, floor or unit number).

      • city

        string — The city.

      • country

        string — Abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country.

      • state_code

        string — Abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state.

      • zip

        string — Zip code.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "emergency_address": {
        "country": "",
        "address_line1": "",
        "address_line2": "",
        "city": "",
        "zip": "",
        "state_code": ""
      },
      "carrier_code": 1,
      "phone_numbers": []
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — Name of the event.

• event_ts (required)

  integer, format: int64 — Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — Account ID of the customer using provider exchange.

  • object (required)

    object

    • carrier_code (required)

      integer — The carrier code.

    • phone_numbers (required)

      array — The phone numbers with emergency address updates.

    • emergency_address

      object — The emergency address info.

      • address_line1 (required)

        string — Emergency address(house number and street name).

      • address_line2

        string — Additional emergency address information (building, floor or unit number).

      • city

        string — The city.

      • country

        string — Abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country.

      • state_code

        string — Abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state.

      • zip

        string — Zip code.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "emergency_address": {
        "country": "",
        "address_line1": "",
        "address_line2": "",
        "city": "",
        "zip": "",
        "state_code": ""
      },
      "carrier_code": 1,
      "phone_numbers": []
    }
  }
}

POST phone.sms_campaign_number_opt_out

• Method: POST
• Path: phone.sms_campaign_number_opt_out
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.sms_campaign_number_opt_out" — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the owner.

  • object (required)

    object — The phone number campaign opt status payload

    • date_time (required)

      string, format: date_time — The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone.

    • phone_number_campaign_opt_statuses (required)

      array — The list of phone number pairs.

      Items:

      • 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.

Example:

{
  "event": "phone.sms_campaign_number_opt_out",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "phone_number_campaign_opt_statuses": [
        {
          "consumer_phone_number": "",
          "zoom_phone_user_number": ""
        }
      ],
      "date_time": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.sms_campaign_number_opt_out" — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the owner.

  • object (required)

    object — The phone number campaign opt status payload

    • date_time (required)

      string, format: date_time — The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone.

    • phone_number_campaign_opt_statuses (required)

      array — The list of phone number pairs.

      Items:

      • 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.

Example:

{
  "event": "phone.sms_campaign_number_opt_out",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "phone_number_campaign_opt_statuses": [
        {
          "consumer_phone_number": "",
          "zoom_phone_user_number": ""
        }
      ],
      "date_time": ""
    }
  }
}

POST phone.caller_ended

• Method: POST
• Path: phone.caller_ended
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the caller.

  • object (required)

    object

    • call_end_time (required)

      string — The GMT time at which the call was ended."yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • call_id (required)

      string — Thr unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — Thr extension ID of the callee.

      • extension_number

        integer, format: int64 — The extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the callee.

      • phone_number

        string — The phone number of the callee in E164 format. Example: +12192818492 Note: phone_number and extension_number can't be empty at the same time.

      • timezone

        string — The timezone of the callee.

      • user_id

        string — The Zoom user ID of the callee.

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • phone_number (required)

        string — The phone number of the caller in E164 format. Example: +12192818492

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — Zoom clients generate an ID when installed on a device. <b>Note:</b> Does not apply to desk phones.

      • extension_id

        string — Extension ID of the caller.

      • extension_number

        integer, format: int64 — The extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the caller.

      • timezone

        string — The timezone of the caller.

      • user_id

        string — The Zoom user ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started,"yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • answer_start_time

      string — The GMT time at which the call was answered, "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • handup_result

      string — The reason the call was ended. Values: Call connected | Call Cancel | Voicemail

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "connection_type": "pstn_off_net"
      },
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "phone_number": "",
        "user_id": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": "",
      "answer_start_time": "",
      "call_end_time": "",
      "handup_result": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the caller.

  • object (required)

    object

    • call_end_time (required)

      string — The GMT time at which the call was ended."yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • call_id (required)

      string — Thr unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — Thr extension ID of the callee.

      • extension_number

        integer, format: int64 — The extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the callee.

      • phone_number

        string — The phone number of the callee in E164 format. Example: +12192818492 Note: phone_number and extension_number can't be empty at the same time.

      • timezone

        string — The timezone of the callee.

      • user_id

        string — The Zoom user ID of the callee.

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • phone_number (required)

        string — The phone number of the caller in E164 format. Example: +12192818492

      • account_code

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

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — Zoom clients generate an ID when installed on a device. <b>Note:</b> Does not apply to desk phones.

      • extension_id

        string — Extension ID of the caller.

      • extension_number

        integer, format: int64 — The extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the caller.

      • timezone

        string — The timezone of the caller.

      • user_id

        string — The Zoom user ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started,"yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • answer_start_time

      string — The GMT time at which the call was answered, "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • handup_result

      string — The reason the call was ended. Values: Call connected | Call Cancel | Voicemail

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "phone_number": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "connection_type": "pstn_off_net"
      },
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "phone_number": "",
        "user_id": "",
        "account_code": "",
        "extension_number": 1,
        "timezone": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": "",
      "answer_start_time": "",
      "call_end_time": "",
      "handup_result": ""
    }
  }
}

POST phone.callee_ended

• Method: POST
• Path: phone.callee_ended
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • call_end_time (required)

      string — The GMT time( in "yyyy-MM-dd'T'HH:mm:ss'Z'" format) at which the call was ended by the callee.

    • call_id (required)

      string — The unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • phone_number (required)

        string — The phone number of the callee in E164 format. Example: +12192818492

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — An ID generated by Zoom clients when installed on a device. <b>Note:</b> Does not apply to desk phones.

      • device_name

        string — The name of device on which the Zoom Client is installed.

      • extension_id

        string — The extension ID of the callee.

      • extension_number

        integer, format: int64 — The extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the callee.

      • name

        string — The callee's user name.

      • timezone

        string — The timezone of the callee.

      • user_id

        string — The Zoom user ID of the callee.

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — The extension ID of the caller.

      • extension_number

        integer, format: int64 — The extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the caller.

      • phone_number

        string — The phone number of the caller in E164 format. Example: +12192818492

      • timezone

        string — The timezone of the caller.

      • user_id

        string — The Zoom user ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • answer_start_time

      string — The GMT time( in "yyyy-MM-dd'T'HH:mm:ss'Z'" format) at which the call was answered.

    • forwarded_by

      object — The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.

      • extension_number

        string — The extension number the call was forwarded from.

      • extension_type

        string — The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist

      • name

        string — The name of the extension the call was forwarded from.

    • redirect_forwarded_by

      object — The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.

      • extension_number

        string — The extension number the call was forwarded from.

      • extension_type

        string — The type of extension the call was forwarded from. Values: autoReceptionist

      • name

        string — The name of the extension the call was forwarded from.

      • phone_number

        string — The phone number the call was forwarded from.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "name": "",
        "phone_number": "",
        "extension_number": 1,
        "timezone": "",
        "device_name": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "phone_number": "",
        "user_id": "",
        "extension_number": 1,
        "timezone": "",
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": "",
      "answer_start_time": "",
      "call_end_time": "",
      "forwarded_by": {
        "name": "",
        "extension_number": "",
        "extension_type": ""
      },
      "redirect_forwarded_by": {
        "name": "",
        "extension_number": "",
        "phone_number": "",
        "extension_type": ""
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • call_end_time (required)

      string — The GMT time( in "yyyy-MM-dd'T'HH:mm:ss'Z'" format) at which the call was ended by the callee.

    • call_id (required)

      string — The unique identifier of the call.

    • callee (required)

      object — Callee object: Represents the person who is called by the caller.

      • phone_number (required)

        string — The phone number of the callee in E164 format. Example: +12192818492

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • device_id

        string — An ID generated by Zoom clients when installed on a device. <b>Note:</b> Does not apply to desk phones.

      • device_name

        string — The name of device on which the Zoom Client is installed.

      • extension_id

        string — The extension ID of the callee.

      • extension_number

        integer, format: int64 — The extension number of the callee.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the callee.

      • name

        string — The callee's user name.

      • timezone

        string — The timezone of the callee.

      • user_id

        string — The Zoom user ID of the callee.

    • caller (required)

      object — Caller object: Represents the person who initiated the call.

      • connection_type

        string, possible values: "pstn_off_net", "voip", "pstn_on_net", "contact_center", "byop" — The connection type.

      • extension_id

        string — The extension ID of the caller.

      • extension_number

        integer, format: int64 — The extension number of the caller.

      • extension_type

        string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "commonAreaPhone", "sharedLineGroup", "zoomRoom", "ciscoRoom/PolycomRoom", "contactCenter", "pstn", "five9", "twilio" — The extension type of the caller.

      • phone_number

        string — The phone number of the caller in E164 format. Example: +12192818492

      • timezone

        string — The timezone of the caller.

      • user_id

        string — The Zoom user ID of the caller.

    • ringing_start_time (required)

      string — The GMT time at which the ringing started in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.

    • answer_start_time

      string — The GMT time( in "yyyy-MM-dd'T'HH:mm:ss'Z'" format) at which the call was answered.

    • forwarded_by

      object — The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.

      • extension_number

        string — The extension number the call was forwarded from.

      • extension_type

        string — The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist

      • name

        string — The name of the extension the call was forwarded from.

    • redirect_forwarded_by

      object — The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.

      • extension_number

        string — The extension number the call was forwarded from.

      • extension_type

        string — The type of extension the call was forwarded from. Values: autoReceptionist

      • name

        string — The name of the extension the call was forwarded from.

      • phone_number

        string — The phone number the call was forwarded from.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "callee": {
        "extension_id": "",
        "extension_type": "user",
        "user_id": "",
        "name": "",
        "phone_number": "",
        "extension_number": 1,
        "timezone": "",
        "device_name": "",
        "device_id": "",
        "connection_type": "pstn_off_net"
      },
      "caller": {
        "extension_id": "",
        "extension_type": "user",
        "phone_number": "",
        "user_id": "",
        "extension_number": 1,
        "timezone": "",
        "connection_type": "pstn_off_net"
      },
      "ringing_start_time": "",
      "answer_start_time": "",
      "call_end_time": "",
      "forwarded_by": {
        "name": "",
        "extension_number": "",
        "extension_type": ""
      },
      "redirect_forwarded_by": {
        "name": "",
        "extension_number": "",
        "phone_number": "",
        "extension_type": ""
      }
    }
  }
}

POST phone.callee_call_history_completed

• Method: POST
• Path: phone.callee_call_history_completed
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.callee_call_history_completed" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • call_logs (required)

      array

      Items:

      • 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.

    • user_id (required)

      string — The user ID of the caller.

Example:

{
  "event": "phone.callee_call_history_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "call_logs": [
        {
          "id": "",
          "call_path_id": "",
          "call_id": "",
          "group_id": "",
          "connect_type": "internal",
          "call_type": "general",
          "direction": "inbound",
          "hide_caller_id": true,
          "end_to_end": true,
          "caller_ext_id": "",
          "caller_name": "",
          "caller_email": "",
          "caller_employee_id": "",
          "caller_did_number": "",
          "caller_account_code": "",
          "caller_ext_number": "",
          "caller_ext_type": "user",
          "caller_number_type": "zoom_pstn",
          "caller_device_private_ip": "",
          "caller_device_public_ip": "",
          "caller_device_type": "",
          "caller_country_iso_code": "",
          "caller_country_code": "",
          "caller_site_id": "",
          "caller_department": "",
          "caller_cost_center": "",
          "callee_ext_id": "",
          "callee_name": "",
          "callee_did_number": "",
          "callee_account_code": "",
          "callee_ext_number": "",
          "callee_email": "",
          "callee_employee_id": "",
          "callee_ext_type": "user",
          "callee_number_type": "zoom_pstn",
          "callee_device_private_ip": "",
          "callee_device_public_ip": "",
          "callee_device_type": "",
          "callee_country_iso_code": "",
          "callee_country_code": "",
          "callee_site_id": "",
          "callee_department": "",
          "callee_cost_center": "",
          "start_time": "",
          "answer_time": "",
          "end_time": "",
          "event": "incoming",
          "result": "answered",
          "result_reason": "answered_by_other",
          "operator_ext_number": "",
          "operator_ext_id": "",
          "operator_ext_type": "user",
          "operator_name": "",
          "recording_id": "",
          "recording_type": "ad-hoc",
          "voicemail_id": "",
          "talk_time": 1,
          "hold_time": 1,
          "wait_time": 1
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.callee_call_history_completed" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • call_logs (required)

      array

      Items:

      • 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.

    • user_id (required)

      string — The user ID of the caller.

Example:

{
  "event": "phone.callee_call_history_completed",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "call_logs": [
        {
          "id": "",
          "call_path_id": "",
          "call_id": "",
          "group_id": "",
          "connect_type": "internal",
          "call_type": "general",
          "direction": "inbound",
          "hide_caller_id": true,
          "end_to_end": true,
          "caller_ext_id": "",
          "caller_name": "",
          "caller_email": "",
          "caller_employee_id": "",
          "caller_did_number": "",
          "caller_account_code": "",
          "caller_ext_number": "",
          "caller_ext_type": "user",
          "caller_number_type": "zoom_pstn",
          "caller_device_private_ip": "",
          "caller_device_public_ip": "",
          "caller_device_type": "",
          "caller_country_iso_code": "",
          "caller_country_code": "",
          "caller_site_id": "",
          "caller_department": "",
          "caller_cost_center": "",
          "callee_ext_id": "",
          "callee_name": "",
          "callee_did_number": "",
          "callee_account_code": "",
          "callee_ext_number": "",
          "callee_email": "",
          "callee_employee_id": "",
          "callee_ext_type": "user",
          "callee_number_type": "zoom_pstn",
          "callee_device_private_ip": "",
          "callee_device_public_ip": "",
          "callee_device_type": "",
          "callee_country_iso_code": "",
          "callee_country_code": "",
          "callee_site_id": "",
          "callee_department": "",
          "callee_cost_center": "",
          "start_time": "",
          "answer_time": "",
          "end_time": "",
          "event": "incoming",
          "result": "answered",
          "result_reason": "answered_by_other",
          "operator_ext_number": "",
          "operator_ext_id": "",
          "operator_ext_type": "user",
          "operator_name": "",
          "recording_id": "",
          "recording_type": "ad-hoc",
          "voicemail_id": "",
          "talk_time": 1,
          "hold_time": 1,
          "wait_time": 1
        }
      ]
    }
  }
}

POST phone.call_element_deleted

• Method: POST
• Path: phone.call_element_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.call_element_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the call log.

  • object (required)

    object

    • user_id (required)

      string — The user ID of the call log owner.

    • call_element_ids

      array — The deleted call element ID list. This will be empty when the delete_all is true.

      Items:

      string

    • delete_all

      boolean — The value is true if the user delete all call logs

    • execute_time

      string — The delete event time in GMT date-time format. All call logs prior to this user have been deleted.

    • move_to_trash

      boolean — If the account has enabled call log trash, this value is true.

Example:

{
  "event": "phone.call_element_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "move_to_trash": true,
      "execute_time": "",
      "delete_all": true,
      "call_element_ids": [
        ""
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.call_element_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the call log.

  • object (required)

    object

    • user_id (required)

      string — The user ID of the call log owner.

    • call_element_ids

      array — The deleted call element ID list. This will be empty when the delete_all is true.

      Items:

      string

    • delete_all

      boolean — The value is true if the user delete all call logs

    • execute_time

      string — The delete event time in GMT date-time format. All call logs prior to this user have been deleted.

    • move_to_trash

      boolean — If the account has enabled call log trash, this value is true.

Example:

{
  "event": "phone.call_element_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "user_id": "",
      "move_to_trash": true,
      "execute_time": "",
      "delete_all": true,
      "call_element_ids": [
        ""
      ]
    }
  }
}

POST phone.voicemail_permanently_deleted

• Method: POST
• Path: phone.voicemail_permanently_deleted
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_permanently_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • voice_mails (required)

      array

      Items:

      • id (required)

        string — The unique identifier of the voice mail.

Example:

{
  "event": "phone.voicemail_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "voice_mails": [
        {
          "id": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.voicemail_permanently_deleted" — The event name.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the callee.

  • object (required)

    object

    • voice_mails (required)

      array

      Items:

      • id (required)

        string — The unique identifier of the voice mail.

Example:

{
  "event": "phone.voicemail_permanently_deleted",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "voice_mails": [
        {
          "id": ""
        }
      ]
    }
  }
}

POST phone.sms_campaign_number_opt_in

• Method: POST
• Path: phone.sms_campaign_number_opt_in
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.sms_campaign_number_opt_in" — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the owner.

  • object (required)

    object — The phone number campaign opt-status payload.

    • date_time (required)

      string, format: date-time — The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone.

    • phone_number_campaign_opt_statuses (required)

      array — The list of phone number pairs.

      Items:

      • 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.

Example:

{
  "event": "phone.sms_campaign_number_opt_in",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "phone_number_campaign_opt_statuses": [
        {
          "consumer_phone_number": "",
          "zoom_phone_user_number": ""
        }
      ],
      "date_time": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string, possible values: "phone.sms_campaign_number_opt_in" — The name of the event.

• event_ts (required)

  integer, format: int64 — The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the owner.

  • object (required)

    object — The phone number campaign opt-status payload.

    • date_time (required)

      string, format: date-time — The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone.

    • phone_number_campaign_opt_statuses (required)

      array — The list of phone number pairs.

      Items:

      • 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.

Example:

{
  "event": "phone.sms_campaign_number_opt_in",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "phone_number_campaign_opt_statuses": [
        {
          "consumer_phone_number": "",
          "zoom_phone_user_number": ""
        }
      ],
      "date_time": ""
    }
  }
}

POST phone.fax_received

• Method: POST
• Path: phone.fax_received
• Tags: phone

Request Body

Content-Type: application/json

• event (required)

  string, possible values: "phone.fax_received" — The event's name.

• event_ts (required)

  integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The owner account ID.

  • object (required)

    object — object

    • create_time (required)

      string, format: date-time — The fax creation time in UTC.

    • direction (required)

      string, possible values: "inbound", "outbound" — The fax log's direction: * inbound * outbound

    • extension_id (required)

      string — The owner's extension ID.

    • extension_type (required)

      string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "sharedLineGroup" — The owner's extension type: * user * callQueue * autoReceptionist * commonArea * sharedLineGroup

    • fax_id (required)

      string — The unique fax session ID.

    • fax_log_id (required)

      string — The unique fax log ID.

    • file_id (required)

      string — The fax PDF file ID.

    • file_pages_count (required)

      integer — The number of pages in the fax file.

    • receiver_extension_id (required)

      string — The receiver extension ID.

    • receiver_extension_number (required)

      string — The receiver extension number.

    • receiver_extension_type (required)

      string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "sharedLineGroup" — The receiver extension type: * user * callQueue * autoReceptionist * commonArea * sharedLineGroup

    • receiver_name (required)

      string — The receiver name.

    • receiver_number (required)

      string — The receiver fax number.

    • receiver_type (required)

      string, possible values: "client", "ata", "pstn", "email", "openapi" — The receiver endpoint type: * client * ata * pstn * email * openapi

    • sender_extension_id (required)

      string — The sender extension ID.

    • sender_extension_number (required)

      string — The sender extension number.

    • sender_extension_type (required)

      string, possible values: "user", "callQueue", "autoReceptionist", "commonArea", "sharedLineGroup" — The sender extension type: * user * callQueue * autoReceptionist * commonArea * sharedLineGroup

    • sender_name (required)

      string — The sender name.

    • sender_number (required)

      string — The sender fax number.

    • sender_type (required)

      string, possible values: "client", "ata", "pstn", "email", "openapi" — The sender endpoint type: * client * ata * pstn * email * openapi

    • site_id (required)

      string — The site ID.

    • site_name (required)

      string — The site name.

    • status (required)

      string, possible values: "failed", "processing", "submitted", "sent", "received" — The fax status: * failed * processing * submitted * sent * received

    • receiver_location

      string — The receiver location.

    • sender_location

      string — The sender location.