Quality of Service Subscription Webhooks

OpenAPI Version: 3.1.1
API Version: 1.0.0

Zoom Quality of Service Subscription (QSS) is an add-on product that enables Developers to receive details about the network traffic in near real-time for users, hosts, and participants in their meetings, webinars, and phone calls. This data can be used to proactively troubleshoot and identify issues as quickly as possible. Contact Zoom Sales to add this feature.\n\n Requirements\n\n In addition to having the QSS product on your account, at least one user on the account must have Developer permissions enabled to be able to create an application that can subscribe to QSS events. This user should create a Zoom app to receive notifications.\n\n Enabling QSS event notifications\n\n On the Feature page for the Marketplace app, enable Event Subscription and add the Event notification endpoint URL to send the webhooks. Click Add events and select QSS. Select the QSS events that you’d like to receive.\n\n Note that you must subscribe to the QSS summary event to receive data from the QoS summary APIs.

Servers

URL: https://{your-endpoint-url}

Operations

webinar.participant_data

Method: POST
Path: webinar.participant_data
Tags: real-time

The Webinar Participant Data event triggers when participants in a webinar make setting changes.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Webinar Participant Data subscription enabled under the QSS event.

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 Zoom Room that is experiencing issues.
- object (required)
  object — Meeting object.
  participant (required)
  object — Participant object.
  data (required)
  array — Array of participant data.
  Items:
  as_internal_ip_address
  string — Sharing internal IP address.
  as_internal_ip_port
  string — Sharing internal IP port.
  audio_internal_ip_address
  string — Audio internal IP address.
  audio_internal_ip_port
  string — Audio internal IP port.
  camera
  string — The type of camera used by the participant during the meeting.
  connection_type
  string — Participant connection type.
  data_center
  string — The data center where the participant's meeting data is stored.
  destination_ip_domain
  string — Destination internal IP domain.
  destination_ip_port
  string — Destination internal IP port.
  device
  string — The type of device used by the participant to join the webinar. The possible values for this field are: * `Phone`: Participant joined via PSTN. * `H.323/SIP`: Participant joined via an H.323 or SIP device. * `Windows`: Participant joined via VoIP using a Windows device. * `Mac`: Participant joined via VoIP using a Mac device. * `iOS`: Participant joined via VoIP using an iOS device. * `Android`: Participant joined via VoIP using an Android device.
  domain
  string — The participant's PC domain.
  harddisk_id
  string — The participant's hard disk ID.
  location
  string — Participant location.
  mac_addr
  string — The participant's MAC address.
  microphone
  string — Participant microphone.
  network_type
  string — Participant network type.
  pc_name
  string — The name of the participant's PC.
  rc_reason
  string — The call reconnection reason: Client crash.
  signaling_internal_ip_address
  string — Signaling internal IP address.
  signaling_internal_ip_port
  string — Signaling internal IP port.
  signaling_ip_address
  string — The participant's signaling IP address for information other than audio, video, or screen sharing.
  speaker
  string — Participant speaker.
  version
  string — The participant's Zoom Client version.
  video_internal_ip_address
  string — Video internal IP address.
  video_internal_ip_port
  string — Video internal IP port.
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — Participant ID.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — Meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "",
            "location": "",
            "network_type": "",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

phone.call_qos_summary

Method: POST
Path: phone.call_qos_summary
Tags: real-time

The Phone call's quality of service (QoS) Summary event triggers when the call ends. Zoom collects the call's quality of service data and sends it in this event.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Enable Event Subscriptions for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Phone call's quality of service (QoS) Summary subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string, possible values: "phone.call_qos_summary" — Name of the event.
event_ts (required)
integer, format: int64 — Timestamp when the event occurred, in milliseconds since epoch. The value of this field is returned in long (int64) format.
payload (required)
object
- account_id (required)
  string — The owner's account ID.
- object (required)
  object
  call_end_time (required)
  string, format: date-time — The date and time when the call ended.
  call_id (required)
  string — The call ID.
  call_qos (required)
  array — The call quality of service (QoS).
  Items:
  qos (required)
  array — The quality of service (QoS) data.
  Items:
  date_time (required)
  string, format: date-time — The date and time when the QoS data was received.
  details (required)
  object — QoS details.
  avg_loss (required)
  string — The average percentage of packets that fail to arrive at their destination.
  bitrate (required)
  string — The number of bits per second, in Kbps, that can be transmitted along a digital network.
  jitter (required)
  string — The variation in the delay of received packets, in milliseconds.
  max_loss (required)
  string — The maximum percentage of packets that fail to arrive at their destination.
  mos (required)
  string — The Mean Opinion Score (MOS). This measures voice quality on a scale of 1 to 5. A score above or equal to 3.5 means good quality, while below 3.5 means poor quality.
  network_delay (required)
  string — The amount of time, in milliseconds, that it takes for a Voice Over IP (VoIP) packet to travel from one point to another.
  network
  string — The type of networks such as LAN, WiFi, VPN etc
  type (required)
  string — The QoS data type: sending or receiving.
  type (required)
  string — The type: caller or callee.
  user_id (required)
  string — The caller or callee's user ID.
  user_email
  string — The caller or callee's email.
  call_start_time (required)
  string, format: date-time — The date and time when the call started.

Example:

{
  "event": "phone.call_qos_summary",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "call_start_time": "",
      "call_end_time": "",
      "call_qos": [
        {
          "type": "",
          "user_id": "",
          "user_email": "",
          "qos": [
            {
              "date_time": "",
              "type": "",
              "details": {
                "bitrate": "",
                "avg_loss": "",
                "max_loss": "",
                "jitter": "",
                "network_delay": "",
                "mos": "",
                "network": ""
              }
            }
          ]
        }
      ]
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

meeting.participant_qos

Method: POST
Path: meeting.participant_qos
Tags: real-time

When participants are in a meeting, the Meeting Participant QoS event collects performance data every 6 seconds, aggregates approximately 10 data points into one record every minute, and sends it.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Meeting Participant QoS subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp when the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  participant (required)
  object — Information about the meeting participant.
  qos (required)
  array — Information about the participant's quality of service (QoS).
  Items:
  date_time (required)
  string, format: date-time — The timestamp when the QoS data was generated.
  details (required)
  object — The QoS details object.
  avg_loss
  string — The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.
  avg_rssi
  string — Average value of the wireless network's received signal strength indicator (RSSI).
  bitrate
  string — The bits per second transmitted along a digital network, in Kbps.
  frame_rate
  string — The rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  jitter
  string — The variation in the delay of received packets, in milliseconds.
  latency
  string — The time it takes a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss. For example, the maximum percentage of packets that failed to arrive at their destination.
  max_rssi
  string — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_rssi
  string — Minimum value of the wireless network's received signal strength indicator (RSSI).
  network_notification
  string, possible values: "network bandwidth low", "internet connection unstable" — The client-triggered network instability notification.
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality level.
  quality_score
  string — The meeting quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi", "notification" — The QoS type. See `type` in [List meeting participants QoS Summary](https://developers.zoom.us/docs/api/rest/reference/qss/methods/#operation/dashboardMeetingParticipantsQOSSummary) for a description.
  user_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is not part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.
  participant_user_id
  string — The participant's universally unique identifier (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "user_id": "",
        "participant_user_id": "",
        "email": "",
        "qos": [
          {
            "date_time": "",
            "type": "audio_input",
            "details": {
              "bitrate": "",
              "latency": "",
              "jitter": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm",
              "network_notification": "network bandwidth low"
            }
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

webinar.participant_data_summary

Method: POST
Path: webinar.participant_data_summary
Tags: real-time

The Webinar Participant Data Summary event triggers when a participant leaves a webinar.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Webinar Participant Data Summary subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string, possible values: "webinar.participant_data_summary" — 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.
- object (required)
  object
  participant (required)
  object
  data (required)
  array
  Items:
  as_internal_ip_address (required)
  string — The sharing internal IP address.
  as_internal_ip_port (required)
  string — The sharing internal IP port.
  audio_internal_ip_address (required)
  string — The audio internal IP address.
  audio_internal_ip_port (required)
  string — The audio internal IP port.
  camera (required)
  string — The camera, such as "Integrated Camera".
  connection_type (required)
  string — The connection type, such as "UDP".
  data_center (required)
  string — The data center, such as "SC (Sub)".
  destination_ip_domain (required)
  string — The destination internal IP domain.
  destination_ip_port (required)
  string — The destination internal IP port.
  device (required)
  string, possible values: "Windows", "Mac", "Phone"
  domain (required)
  string
  harddisk_id (required)
  string — The hard disk ID.
  location (required)
  string — The participant's location, formatted as "city (country code)", such as "Sunnyvale (US)".
  mac_addr (required)
  string — The MAC address, only available for the Windows client.
  microphone (required)
  string — The microphone, such as "External Microphone (External Microphone)".
  network_type (required)
  string, possible values: "Wired", "Wifi", "PPP", "3G", "Others"
  pc_name (required)
  string
  signaling_internal_ip_address (required)
  string — The signaling internal IP address.
  signaling_internal_ip_port (required)
  string — The signaling internal IP port.
  signaling_ip_address (required)
  string — The signaling IP address for information other than audio, video, or screen sharing.
  speaker (required)
  string — The headphones, such as "External Headphones (External Headphones)".
  version (required)
  string
  video_internal_ip_address (required)
  string — The video internal IP address.
  video_internal_ip_port (required)
  string — The video internal IP port.
  rc_reason
  string — The reason for call reconnection, such as "Client crash".
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — The participant ID.
  email
  string, format: email — The participant's email address. This field only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/using-zoom-apis/#email-address-display-rules) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — The webinar ID.

Example:

{
  "event": "webinar.participant_data_summary",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "Windows",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

webinar.participant_qos

Method: POST
Path: webinar.participant_qos
Tags: real-time

When participants are in a webinar, the Webinar Participant QoS event collects performance metrics every 6 seconds. Zoom aggregates roughly 10 data into a single record every minute, then sends it to your endpoint.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for details.
Event Subscriptions must be enabled for your Marketplace app, including:
- A valid Event Notification Endpoint URL.
- The Webinar Participant QoS event enabled under the QSS event category.

Request Body

Content-Type: application/json

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — Timestamp in milliseconds since epoch when the event occurred. The value is returned in long (int64) format.
payload (required)
object
- account_id (required)
  string — The Account ID associated with the event.
- object (required)
  object — Meeting object.
  participant (required)
  object — Participant object.
  qos (required)
  array — An array of Quality of Service (QoS) data.
  Items:
  date_time (required)
  string — The timestamp for when the participant left.
  details (required)
  object — Quality of Service (QoS) details object.
  avg_loss
  string — The average amount of packet loss, displayed as the percentage of packets that failed to arrive at their destination.
  avg_rssi
  string — Average value of the wireless network's received signal strength indicator (RSSI).
  bitrate
  string — The number of bits per second that can be transmitted along a digital network, in Kbps.
  frame_rate
  string — The rate at which your video camera can produce unique images, or frames. Zoom supports a frame rate of up to 30 frames per second (FPS).
  jitter
  string — The variation in the delay of received packets, in milliseconds.
  latency
  string — The amount of time it takes for a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss, displayed as the maximum percentage of packets that failed to arrive at their destination.
  max_rssi
  string — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_rssi
  string — Minimum value of the wireless network's received signal strength indicator (RSSI).
  network_notification
  string, possible values: "network bandwidth low", "internet connection unstable" — Client-triggered network instability notification.
  quality
  object
  quality_score
  string — The quality score value.
  resolution
  string — The number of pixels in each dimension that can be displayed by your video camera.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — System's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi", "notification" — Quality of Service (QoS) type.
  user_id (required)
  string — The participant's unique identifier.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is not part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
  participant_user_id
  string — The participant's universally unique identifier (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID).

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "user_id": "",
        "participant_user_id": "",
        "email": "",
        "qos": [
          {
            "date_time": "",
            "type": "audio_input",
            "details": {
              "bitrate": "",
              "latency": "",
              "jitter": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": null,
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm",
              "network_notification": "network bandwidth low"
            }
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

session.user_qos_summary

Method: POST
Path: session.user_qos_summary
Tags: real-time

The Session User QoS Summary event triggers when a user leaves a session. The collected QoS metrics for that user are then sent via this event.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for details.
Event Subscriptions must be enabled for your Video SDK Marketplace app, including:
- A valid Event Notification Endpoint URL.
- The Session User QoS Summary event enabled under the QSS event category.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id
  string — The unique session identifier. Each session instance has its own session ID.
  session_key
  string — The Video SDK custom session ID.
  session_name
  string — The session's name.
  user
  object — Information about the user.
  id (required)
  string — The user's unique ID assigned upon joining the session, valid only for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name (required)
  string — The user's username.
  qos (required)
  array — Information about the user's quality of service (QoS).
  Items:
  details (required)
  object
  avg_bitrate
  string — The average bits per second transmitted along a digital network, in Kbps.
  avg_frame_rate
  string — The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  avg_jitter
  string — The average variation in the delay of received packets, in milliseconds.
  avg_latency
  string — The average time it took a packet to travel from one point to another, in milliseconds.
  avg_loss
  string — The average amount of packet loss as a percentage of packets that failed to arrive at their destination.
  avg_rssi
  integer — Average value of the wireless network's received signal strength indicator (RSSI).
  max_bitrate
  string — The maximum bits per second transmitted along a digital network, in Kbps.
  max_frame_rate
  string — The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  max_jitter
  string — The maximum variation in the delay of received packets, in milliseconds.
  max_latency
  string — The maximum time it took a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss as a percentage of packets that failed to arrive at their destination.
  max_rssi
  integer — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_bitrate
  string — The minimum bits per second transmitted along a digital network, in Kbps.
  min_frame_rate
  string — The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  min_jitter
  string — The minimum variation in the delay of received packets, in milliseconds.
  min_latency
  string — The minimum time it took a packet to travel from one point to another, in milliseconds.
  min_loss
  string — The minimum amount of packet loss as a percentage of packets that failed to arrive at their destination.
  min_rssi
  integer — Minimum value of the wireless network's received signal strength indicator (RSSI).
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality assessment.
  quality_score
  string — The session quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi" — The QoS type.
  user_key
  string — An additional identifier for the user. Can be numeric or alphanumeric.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "qos": [
          {
            "type": "audio_input",
            "details": {
              "min_bitrate": "",
              "avg_bitrate": "",
              "max_bitrate": "",
              "min_latency": "",
              "avg_latency": "",
              "max_latency": "",
              "min_jitter": "",
              "avg_jitter": "",
              "max_jitter": "",
              "min_loss": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "min_frame_rate": "",
              "avg_frame_rate": "",
              "max_frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm"
            }
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

webinar.participant_qos_summary

Method: POST
Path: webinar.participant_qos_summary
Tags: real-time

The Webinar Participant QoS Summary event triggers each time a participant leaves a webinar. The collected QoS metrics for that participant are then sent via this event.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for details.
Event Subscriptions must be enabled for your Marketplace app, including:
- A valid Event Notification Endpoint URL.
- The Webinar Participant QoS Summary event enabled under the QSS event category.

Request Body

Content-Type: application/json

event (required)
string, possible values: "webinar.participant_qos_summary" — The event's name.
event_ts (required)
integer, format: int64 — The timestamp in milliseconds since epoch when the event occurred, in long (int64) format.
payload (required)
object
- account_id (required)
  string
- object (required)
  object
  id
  string — The webinar number.
  participant
  object
  email (required)
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.
  id (required)
  string — The participant's universally unique identifier (UUID): * If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/users/#tag/users/get/users/{userId}) API response. * If the participant joins the meeting **without** logging into Zoom, this returns an empty ("") value.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  qos (required)
  array
  Items:
  details (required)
  object
  avg_bitrate
  string — The average bits per second transmitted along a digital network, in Kbps.
  avg_frame_rate
  string — The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  avg_jitter
  string — The average variation in the delay of received packets, in milliseconds.
  avg_latency
  string — The average time it took a packet to travel from one point to another, in milliseconds.
  avg_loss
  string — The average amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  avg_rssi
  integer — The average value of the wireless network's received signal strength indicator (RSSI).
  max_bitrate
  string — The maximum bits per second transmitted along a digital network, in Kbps.
  max_frame_rate
  string — The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  max_jitter
  string — The maximum variation in the delay of received packets, in milliseconds.
  max_latency
  string — The maximum time it took a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  max_rssi
  integer — The maximum value of the wireless network's received signal strength indicator (RSSI).
  min_bitrate
  string — The minimum bits per second transmitted along a digital network, in Kbps.
  min_frame_rate
  string — The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  min_jitter
  string — The minimum variation in the delay of received packets, in milliseconds.
  min_latency
  string — The minimum time it took a packet to travel from one point to another, in milliseconds.
  min_loss
  string — The minimum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  min_rssi
  integer — The minimum value of the wireless network's received signal strength indicator (RSSI).
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality object.
  quality_score
  string — The meeting quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — The unit of measurement for the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi"
  user_name (required)
  string — The participant's display name.
  uuid
  string — The webinar's universally unique identifier (UUID).

Example:

{
  "event": "webinar.participant_qos_summary",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "id": "",
      "participant": {
        "participant_id": "",
        "user_name": "",
        "id": "",
        "email": "",
        "qos": [
          {
            "type": "audio_input",
            "details": {
              "min_bitrate": "",
              "avg_bitrate": "",
              "max_bitrate": "",
              "min_latency": "",
              "avg_latency": "",
              "max_latency": "",
              "min_jitter": "",
              "avg_jitter": "",
              "max_jitter": "",
              "min_loss": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "min_frame_rate": "",
              "avg_frame_rate": "",
              "max_frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-75",
              "avg_rssi": "-69",
              "min_rssi": "-35",
              "rssi_unit": "dBm"
            }
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

meeting.participant_data

Method: POST
Path: meeting.participant_data
Tags: real-time

The Meeting Participant Data event triggers when participants in a meeting make setting changes. For example, when a participant enables their camera, there will be an event notification triggered during the meeting. When you subscribe to this event, you will receive multiple events in one meeting for each participant.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Meeting Participant Data subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — A timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  participant (required)
  object — Information about the meeting participant.
  data (required)
  array — The participant's data information.
  Items:
  as_internal_ip_address
  string — The participant's sharing internal IP address.
  as_internal_ip_port
  string — The participant's sharing internal IP port.
  audio_internal_ip_address
  string — The participant's audio internal IP address.
  audio_internal_ip_port
  string — The participant's audio internal IP port.
  camera
  string — The type of camera that the participant used during the meeting.
  connection_type
  string — The participant's connection type.
  data_center
  string — The data center where participant's meeting data is stored.
  destination_ip_domain
  string — The participant's destination internal IP domain.
  destination_ip_port
  string — The participant's destination internal IP port.
  device
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the participant used to join the meeting: * `Phone` — The participant joined via PSTN. * `H.323/SIP` — The participant joined via an H.323 or SIP device. * `Windows` — The participant joined via VoIP using a Windows device. * `Mac` — The participant joined via VoIP using a Mac device. * `iOS` — The participant joined via VoIP using an iOS device. * `Android` — The participant joined via VoIP using an Android device.
  domain
  string — The participant's PC domain.
  harddisk_id
  string — The participant's hard disk ID.
  location
  string — The participant's location.
  Location
  string — Deprecated, use `location`.
  mac_addr
  string — The participant's MAC address.
  microphone
  string — The type of microphone that the participant used during the meeting.
  network_type
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The participant's network type: * `Wired` * `Wifi` * `PPP` — Point-to-Point. * `Cellular` — 3G, 4G, and 5G cellular. * `Others` — An unknown device.
  pc_name
  string — The participant's PC name.
  rc_reason
  string — The call reconnection reason: Client crash.
  signaling_internal_ip_address
  string — The participant's signaling internal IP address.
  signaling_internal_ip_port
  string — The participant's signaling internal IP port.
  signaling_ip_address
  string — The participant's signaling IP address for information other than audio, video, or share screen.
  speaker
  string — The type of speaker that the participant used during the meeting.
  version
  string — The participant's Zoom client version.
  video_internal_ip_address
  string — The participant's video internal IP address.
  video_internal_ip_port
  string — The participant's video internal IP port.
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

phone.call_qos

Method: POST
Path: phone.call_qos
Tags: real-time

When the call is on-going, the Phone call's quality of service (QoS) event collects performance data every 6 seconds, aggregates approximately 10 data points into one record every minute, and sends it.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Phone call's quality of service (QoS) subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string, possible values: "phone.call_qos" — Name of the event.
event_ts (required)
integer, format: int64 — Timestamp when the event occurred, in milliseconds since epoch. 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 object type.
  call_id (required)
  string — The call ID.
  call_qos (required)
  object — The call quality of service (QoS).
  id (required)
  string — The caller or callee's ID.
  qos (required)
  object — The quality of service (QoS) data.
  date_time (required)
  string, format: date-time — The date and time when the QoS data was received.
  details (required)
  object — The quality of service (QoS) details.
  avg_loss (required)
  string — The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.
  bitrate (required)
  string — The bits per second transmitted along a digital network, in Kbsp.
  jitter (required)
  string — The variation in the delay of received packets, in milliseconds.
  max_loss (required)
  string — The maximum amount of packet loss. For example, the maximum percentage of packets that failed to arrive at their destination.
  mos (required)
  string — The Mean Opinion Score (MOS). This measures voice quality on a scale of 1 to 5. A score above or equal to 3.5 means good quality, while below 3.5 means poor quality.
  network_delay (required)
  string — The amount of time, in milliseconds, that it takes for a Voice Over IP (VoIP) packet to travel from one point to another.
  network
  string — The type of networks such as LAN, WiFi, VPN etc
  type (required)
  string — The QoS type: sending or receiving.
  type (required)
  string — The type: caller or callee.
  user_email
  string — The caller or callee's email address.
  call_start_time (required)
  string, format: date-time — The date and time when the call started.
  call_end_time
  string, format: date-time — The date and time when the call ended. Only shows up if the call ended.

Example:

{
  "event": "phone.call_qos",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "call_start_time": "",
      "call_end_time": "",
      "call_qos": {
        "type": "",
        "id": "",
        "user_email": "",
        "qos": {
          "date_time": "",
          "type": "",
          "details": {
            "bitrate": "",
            "avg_loss": "",
            "max_loss": "",
            "jitter": "",
            "network_delay": "",
            "mos": "",
            "network": ""
          }
        }
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

session.user_data

Method: POST
Path: session.user_data
Tags: real-time

The Session user Data event triggers when users in a session make setting changes.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Enable Event Subscriptions for your Video SDK Marketplace app with:
- A valid Event Notification Endpoint URL.
- The Session user Data subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — The timestamp when the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id (required)
  string — A unique session identifier. Each instance of the session will have its own `session_id`.
  session_name (required)
  string — The session name.
  user (required)
  object — Information about the session user.
  data (required)
  array — The user's session data.
  Items:
  as_internal_ip_address
  string — The user's sharing internal IP address.
  as_internal_ip_port
  string — The user's sharing internal IP port.
  audio_internal_ip_address
  string — The user's audio internal IP address.
  audio_internal_ip_port
  string — The user's audio internal IP port.
  camera
  string — The type of camera that the user used during the session.
  connection_type
  string — The user's connection type.
  data_center
  string — The data center where the user's session data is stored.
  destination_ip_domain
  string — The user's destination internal IP domain.
  destination_ip_port
  string — The user's destination internal IP port.
  device
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the user used to join the session. * `Phone` - The user joined via PSTN. * `H.323/SIP` - The user joined via an H.323 or SIP device. * `Windows` - The user joined via VoIP using a Windows device. * `Mac` - The user joined via VoIP using a macOS device. * `iOS` - The user joined via VoIP using an iOS device. * `Android` - The user joined via VoIP using an Android device.
  domain
  string — The user's PC domain.
  harddisk_id
  string — The user's hard disk ID.
  location
  string — The user's location.
  mac_addr
  string — The user's MAC address.
  microphone
  string — The type of microphone that the user used during the session.
  network_type
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The user's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown device.
  pc_name
  string — The user's PC name.
  rc_reason
  string — The call reconnection reason, such as a client crash.
  signaling_internal_ip_address
  string — The user's signaling internal IP address.
  signaling_internal_ip_port
  string — The user's signaling internal IP port.
  signaling_ip_address
  string — The user's signaling IP address for information other than audio, video, or screen sharing.
  speaker
  string — The type of speaker that the user used during the session.
  version
  string — The user's Zoom client version.
  video_internal_ip_address
  string — The user's video internal IP address.
  video_internal_ip_port
  string — The user's video internal IP port.
  id (required)
  string — The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name
  string — The user's username.
  user_key
  string — Another identifier for the user. The value can be numeric or alphanumeric.
  session_key
  string — The Video SDK custom session ID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

meeting.participant_data_summary

Method: POST
Path: meeting.participant_data_summary
Tags: real-time

Zoom triggers the Meeting Participant Data Summary event when a participant leaves a meeting.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Meeting Participant Data Summary subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  participant (required)
  object — Information about the meeting participant.
  data (required)
  array — The participant's data details.
  Items:
  as_internal_ip_address (required)
  string — The participant's sharing internal IP address.
  as_internal_ip_port (required)
  string — The participant's sharing internal IP port.
  audio_internal_ip_address (required)
  string — The participant's audio internal IP address.
  audio_internal_ip_port (required)
  string — The participant's audio internal IP port.
  camera (required)
  string — The type of camera that the participant used during the meeting.
  connection_type (required)
  string — The participant's connection type.
  data_center (required)
  string — The data center where the participant's meeting data is stored.
  destination_ip_domain (required)
  string — The participant's destination internal IP domain.
  destination_ip_port (required)
  string — The participant's destination internal IP port.
  device (required)
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the participant used to join the meeting: * `Phone` — The participant joined via PSTN. * `H.323/SIP` — The participant joined via an H.323 or SIP device. * `Windows` — The participant joined via VoIP using a Windows device. * `Mac` — The participant joined via VoIP using a Mac device. * `iOS` — The participant joined via VoIP using an iOS device. * `Android` — The participant joined via VoIP using an Android device.
  domain (required)
  string — The participant's PC domain.
  harddisk_id (required)
  string — The participant's hard disk ID.
  location (required)
  string — The participant's location.
  mac_addr (required)
  string — The participant's MAC address.
  microphone (required)
  string — The type of microphone that the participant used during the meeting.
  network_type (required)
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The participant's network type: * `Wired` * `Wifi` * `PPP` — Point-to-Point. * `Cellular` — 3G, 4G, and 5G cellular. * `Others` — An unknown device.
  pc_name (required)
  string — The participant's PC name.
  signaling_internal_ip_address (required)
  string — The participant's signaling internal IP address.
  signaling_internal_ip_port (required)
  string — The participant's signaling internal IP port.
  signaling_ip_address (required)
  string — The participant's signaling IP address for information other than audio, video, or screen sharing.
  speaker (required)
  string — The type of speaker that the participant used during the meeting.
  version (required)
  string — The participant's Zoom client version.
  video_internal_ip_address (required)
  string — The participant's video internal IP address.
  video_internal_ip_port (required)
  string — The participant's video internal IP port.
  client
  string — The participant's SDK client version.
  device_detail
  string — The participant's detailed device information.
  rc_reason
  string — The call reconnection reason, for example, `Client crash`.
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID.
  id
  string — The meeting ID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "id": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "device_detail": "",
            "client": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

session.user_data_summary

Method: POST
Path: session.user_data_summary
Tags: real-time

The Session User Data Summary event triggers when a user leaves a session.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Enable Event Subscriptions for your Video SDK Marketplace app with:
- A valid Event Notification Endpoint URL.
- The Session User Data Summary subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id (required)
  string — A unique session identifier. Each instance of the session will have its own `session_id`.
  session_name (required)
  string — Session name.
  user (required)
  object — Information about the session user.
  data (required)
  array — The user's session data.
  Items:
  as_internal_ip_address (required)
  string — The user's sharing internal IP address.
  as_internal_ip_port (required)
  string — The user's sharing internal IP port.
  audio_internal_ip_address (required)
  string — The user's audio internal IP address.
  audio_internal_ip_port (required)
  string — The user's audio internal IP port.
  camera (required)
  string — The type of camera that the user used during the session.
  connection_type (required)
  string — The user's connection type.
  data_center (required)
  string — The data center where the user's session data is stored.
  destination_ip_domain (required)
  string — The user's destination internal IP domain.
  destination_ip_port (required)
  string — The user's destination internal IP port.
  device (required)
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the user used to join the session. * `Phone` - The user joined via PSTN. * `H.323/SIP` - The user joined via an H.323 or SIP device. * `Windows` - The user joined via VoIP using a Windows device. * `Mac` - The user joined via VoIP using a macOS device. * `iOS` - The user joined via VoIP using an iOS device. * `Android` - The user joined via VoIP using an Android device.
  domain (required)
  string — The user's PC domain.
  harddisk_id (required)
  string — The user's hard disk ID.
  location (required)
  string — The user's location.
  mac_addr (required)
  string — The user's MAC address.
  microphone (required)
  string — The type of microphone that the user used during the session.
  network_type (required)
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The user's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown network type.
  pc_name (required)
  string — The user's PC name.
  signaling_internal_ip_address (required)
  string — The user's signaling internal IP address.
  signaling_internal_ip_port (required)
  string — The user's signaling internal IP port.
  signaling_ip_address (required)
  string — The user's signaling IP address for information other than audio, video, or screen sharing.
  speaker (required)
  string — The type of speaker that the user used during the session.
  version (required)
  string — The user's Zoom client version.
  video_internal_ip_address (required)
  string — The user's video internal IP address.
  video_internal_ip_port (required)
  string — The user's video internal IP port.
  client
  string — The user's SDK client version.
  device_detail
  string — The user's detailed device information.
  rc_reason
  string — The reason for call reconnection, such as a client crash.
  id (required)
  string — The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name
  string — The user's username.
  user_key
  string — Another identifier for the user. Can be numeric or alphanumeric.
  session_key
  string — The Video SDK custom session ID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "device_detail": "",
            "client": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

meeting.participant_qos_summary

Method: POST
Path: meeting.participant_qos_summary
Tags: real-time

The Meeting Participant QoS Summary event triggers when a participant leaves a meeting. The meeting participants' QoS data is then collected and sent via this event.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for more information.
Event Subscriptions must be enabled for your Marketplace app with the following configurations:
- A valid Event Notification Endpoint URL.
- The Meeting Participant QoS Summary subscription enabled under the QSS event.

Request Body

Content-Type: application/json

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  id
  string — The meeting ID.
  participant
  object — Information about the meeting participant.
  email (required)
  string, format: email — The participant's email address. Only returned if the participant joined the meeting by logging into Zoom.
  id (required)
  string — The participant's universally unique ID (UUID): * If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/rest/reference/zoom-api/methods/#operation/user) API response. * If the participant joins the meeting **without** logging into Zoom, this returns an empty (`""`) value.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting duration.
  qos (required)
  array — Information about the participant's quality of service (QoS).
  Items:
  details (required)
  object
  avg_bitrate
  string — The average bits per second transmitted along a digital network, in Kbps.
  avg_frame_rate
  string — The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  avg_jitter
  string — The average variation in the delay of received packets, in milliseconds.
  avg_latency
  string — The average time it took a packet to travel from one point to another, in milliseconds.
  avg_loss
  string — The average amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  avg_rssi
  integer — The average value of the wireless network's received signal strength indicator (RSSI).
  max_bitrate
  string — The maximum bits per second transmitted along a digital network, in Kbps.
  max_frame_rate
  string — The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  max_jitter
  string — The maximum variation in the delay of received packets, in milliseconds.
  max_latency
  string — The maximum time it took a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  max_rssi
  integer — The maximum value of the wireless network's received signal strength indicator (RSSI).
  min_bitrate
  string — The minimum bits per second transmitted along a digital network, in Kbps.
  min_frame_rate
  string — The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  min_jitter
  string — The minimum variation in the delay of received packets, in milliseconds.
  min_latency
  string — The minimum time it took a packet to travel from one point to another, in milliseconds.
  min_loss
  string — The minimum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  min_rssi
  integer — The minimum value of the wireless network's received signal strength indicator (RSSI).
  quality
  string, possible values: "bad", "fair", "good", "poor" — Meeting Quality Object
  quality_score
  string — The meeting quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — The unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi" — The type of quality of service (QoS) metrics, from the point of view of the client. See [List meeting participants QoS Summary](https://developers.zoom.us/docs/api/rest/reference/qss/methods/#operation/dashboardMeetingParticipantsQOSSummary) for descriptions.
  user_name (required)
  string — The participant's display name.
  uuid
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a unique meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "id": "",
      "participant": {
        "participant_id": "",
        "user_name": "",
        "id": "",
        "email": "",
        "qos": [
          {
            "type": "audio_input",
            "details": {
              "min_bitrate": "",
              "avg_bitrate": "",
              "max_bitrate": "",
              "min_latency": "",
              "avg_latency": "",
              "max_latency": "",
              "min_jitter": "",
              "avg_jitter": "",
              "max_jitter": "",
              "min_loss": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "min_frame_rate": "",
              "avg_frame_rate": "",
              "max_frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm"
            }
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

session.user_qos

Method: POST
Path: session.user_qos
Tags: real-time

When users are in a session, the Session User QoS event collects performance metrics every 6 seconds. Zoom aggregates roughly 10 data points into a single record every minute and sends that record to your configured endpoint.

Prerequisites

A Quality of Service Subscription plan. Contact Zoom Sales for details.
Event Subscriptions must be enabled for your Video SDK Marketplace app, including:
- A valid Event Notification Endpoint URL.
- The Session User QoS subscription enabled under the QSS event category.

Request Body

Content-Type: application/json

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id (required)
  string — The unique session identifier. Each instance of the session will have its own session_id.
  session_name (required)
  string — The session name.
  user (required)
  object — Information about the user.
  id (required)
  string — The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name (required)
  string — The user's username.
  qos (required)
  array — Information about the user's quality of service (QoS).
  Items:
  date_time (required)
  string — The timestamp when the QoS data was recorded.
  details (required)
  object — The QoS details object.
  avg_loss
  string — The average packet loss percentage.
  avg_rssi
  string — Average value of the wireless network's received signal strength indicator (RSSI).
  bitrate
  string — The transmission rate in kilobits per second (Kbps) along the digital network.
  frame_rate
  string — The rate at which the camera produces unique frames. Zoom supports up to 30 frames per second (FPS).
  jitter
  string — The variation in the delay of received packets, in milliseconds.
  latency
  string — The time it takes for a packet to travel from one point to another, measured in milliseconds.
  max_loss
  string — The maximum packet loss percentage.
  max_rssi
  string — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_rssi
  string — Minimum value of the wireless network's received signal strength indicator (RSSI).
  network_notification
  string, possible values: "network bandwidth low", "internet connection unstable" — Client-triggered network instability notification.
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality level.
  quality_score
  string — The session quality score.
  resolution
  string — The video resolution in pixels that the camera can display.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi", "notification" — The QoS type. - `audio_input` — The QoS metrics for audio sent by a user. - `audio_output` — The QoS metrics for audio received by a user. - `video_input` — The QoS metrics for video input sent by a user. - `video_output` — The QoS metrics for video output received by a user. - `as_input` — The QoS metrics for screen sharing sent by a user. - `as_output` — The QoS metrics for screen sharing output received by a user. - `cpu_usage` — The QoS metrics for CPU usage. - `audio_device_from_crc` — The QoS metrics for audio sent by a user who joined the session via a Cloud Room Connector (CRC). - `audio_device_to_crc` — The QoS metrics for audio received by a user who joined the session via CRC. - `video_device_from_crc` — The QoS metrics for video input sent by a user who joined the session via CRC. - `video_device_to_crc` — The QoS metrics for video output received by a user who joined the session via CRC. - `as_device_from_crc` — The QoS metrics for screen sharing sent by a user who joined the session via CRC. - `as_device_to_crc` — The QoS metrics for screen sharing output received by a user who joined the session via CRC. - `audio_device_from_rwg` — The QoS metrics for audio sent by a participant who joined the meeting via the web client. - `audio_device_to_rwg` — The QoS metrics for audio received by a participant who joined the meeting via the web client. - `video_device_from_rwg` — The QoS metrics for video sent by a participant who joined the meeting via the web client. - `video_device_to_rwg` — The QoS metrics for video received by a participant who joined the meeting via the web client. - `as_device_from_rwg` — The QoS metrics for screen sharing sent by a participant who joined the meeting via the web client. - `as_device_to_rwg` — The QoS metrics for screen sharing received by a participant who joined the meeting via the web client. - `audio_quality` — `good`: The audio is almost flawless and the quality is excellent. `fair`: The audio occasionally has distortion, noise, or other problems, but the content is basically continuous and users can communicate normally. `poor`: The audio often has distortion, noise, or other problems, but the content is basically continuous and users can communicate normally. `bad`: The sound quality is extremely poor and the audio content is almost inaudible. - `video_quality` — `good`: The video is almost flawless and the quality is excellent. `fair`: The video definition is high and occasionally gets stuck or has other problems, but the frequency is very low and the video quality is good. `poor`: The video definition is not high, but not many problems exist. The video quality is mediocre. `bad`: The picture is very blurred and often gets stuck. - `as_quality` — `good`: The screen sharing is almost flawless and the quality is excellent. `fair`: The screen sharing definition is high and occasionally gets stuck or has other problems, but the frequency is very low and the quality is good. `poor`: The screen sharing definition is not high, but not many problems exist. The quality is mediocre. `bad`: The picture is very blurred and often gets stuck. - `wifi_rssi` — The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network. - `notification` — The notification type.
  user_key
  string — An additional identifier for the user. Can be numeric or alphanumeric.
  session_key
  string — The Video SDK custom session identifier.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "qos": [
          {
            "date_time": "",
            "type": "audio_input",
            "details": {
              "bitrate": "",
              "latency": "",
              "jitter": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm",
              "network_notification": "network bandwidth low"
            }
          }
        ]
      }
    }
  }
}

Responses

Status: 200 Successfully received the webhook event.

Schemas

Webinar.participant_dataEvent

Type:object

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 Zoom Room that is experiencing issues.
- object (required)
  object — Meeting object.
  participant (required)
  object — Participant object.
  data (required)
  array — Array of participant data.
  Items:
  as_internal_ip_address
  string — Sharing internal IP address.
  as_internal_ip_port
  string — Sharing internal IP port.
  audio_internal_ip_address
  string — Audio internal IP address.
  audio_internal_ip_port
  string — Audio internal IP port.
  camera
  string — The type of camera used by the participant during the meeting.
  connection_type
  string — Participant connection type.
  data_center
  string — The data center where the participant's meeting data is stored.
  destination_ip_domain
  string — Destination internal IP domain.
  destination_ip_port
  string — Destination internal IP port.
  device
  string — The type of device used by the participant to join the webinar. The possible values for this field are: * `Phone`: Participant joined via PSTN. * `H.323/SIP`: Participant joined via an H.323 or SIP device. * `Windows`: Participant joined via VoIP using a Windows device. * `Mac`: Participant joined via VoIP using a Mac device. * `iOS`: Participant joined via VoIP using an iOS device. * `Android`: Participant joined via VoIP using an Android device.
  domain
  string — The participant's PC domain.
  harddisk_id
  string — The participant's hard disk ID.
  location
  string — Participant location.
  mac_addr
  string — The participant's MAC address.
  microphone
  string — Participant microphone.
  network_type
  string — Participant network type.
  pc_name
  string — The name of the participant's PC.
  rc_reason
  string — The call reconnection reason: Client crash.
  signaling_internal_ip_address
  string — Signaling internal IP address.
  signaling_internal_ip_port
  string — Signaling internal IP port.
  signaling_ip_address
  string — The participant's signaling IP address for information other than audio, video, or screen sharing.
  speaker
  string — Participant speaker.
  version
  string — The participant's Zoom Client version.
  video_internal_ip_address
  string — Video internal IP address.
  video_internal_ip_port
  string — Video internal IP port.
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — Participant ID.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — Meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "",
            "location": "",
            "network_type": "",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Phone.call_qos_summaryEvent

Type:object

event (required)
string, possible values: "phone.call_qos_summary" — Name of the event.
event_ts (required)
integer, format: int64 — Timestamp when the event occurred, in milliseconds since epoch. The value of this field is returned in long (int64) format.
payload (required)
object
- account_id (required)
  string — The owner's account ID.
- object (required)
  object
  call_end_time (required)
  string, format: date-time — The date and time when the call ended.
  call_id (required)
  string — The call ID.
  call_qos (required)
  array — The call quality of service (QoS).
  Items:
  qos (required)
  array — The quality of service (QoS) data.
  Items:
  date_time (required)
  string, format: date-time — The date and time when the QoS data was received.
  details (required)
  object — QoS details.
  avg_loss (required)
  string — The average percentage of packets that fail to arrive at their destination.
  bitrate (required)
  string — The number of bits per second, in Kbps, that can be transmitted along a digital network.
  jitter (required)
  string — The variation in the delay of received packets, in milliseconds.
  max_loss (required)
  string — The maximum percentage of packets that fail to arrive at their destination.
  mos (required)
  string — The Mean Opinion Score (MOS). This measures voice quality on a scale of 1 to 5. A score above or equal to 3.5 means good quality, while below 3.5 means poor quality.
  network_delay (required)
  string — The amount of time, in milliseconds, that it takes for a Voice Over IP (VoIP) packet to travel from one point to another.
  network
  string — The type of networks such as LAN, WiFi, VPN etc
  type (required)
  string — The QoS data type: sending or receiving.
  type (required)
  string — The type: caller or callee.
  user_id (required)
  string — The caller or callee's user ID.
  user_email
  string — The caller or callee's email.
  call_start_time (required)
  string, format: date-time — The date and time when the call started.

Example:

{
  "event": "phone.call_qos_summary",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "call_start_time": "",
      "call_end_time": "",
      "call_qos": [
        {
          "type": "",
          "user_id": "",
          "user_email": "",
          "qos": [
            {
              "date_time": "",
              "type": "",
              "details": {
                "bitrate": "",
                "avg_loss": "",
                "max_loss": "",
                "jitter": "",
                "network_delay": "",
                "mos": "",
                "network": ""
              }
            }
          ]
        }
      ]
    }
  }
}

Meeting.participant_qosEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp when the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  participant (required)
  object — Information about the meeting participant.
  qos (required)
  array — Information about the participant's quality of service (QoS).
  Items:
  date_time (required)
  string, format: date-time — The timestamp when the QoS data was generated.
  details (required)
  object — The QoS details object.
  avg_loss
  string — The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.
  avg_rssi
  string — Average value of the wireless network's received signal strength indicator (RSSI).
  bitrate
  string — The bits per second transmitted along a digital network, in Kbps.
  frame_rate
  string — The rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  jitter
  string — The variation in the delay of received packets, in milliseconds.
  latency
  string — The time it takes a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss. For example, the maximum percentage of packets that failed to arrive at their destination.
  max_rssi
  string — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_rssi
  string — Minimum value of the wireless network's received signal strength indicator (RSSI).
  network_notification
  string, possible values: "network bandwidth low", "internet connection unstable" — The client-triggered network instability notification.
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality level.
  quality_score
  string — The meeting quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi", "notification" — The QoS type. See `type` in [List meeting participants QoS Summary](https://developers.zoom.us/docs/api/rest/reference/qss/methods/#operation/dashboardMeetingParticipantsQOSSummary) for a description.
  user_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is not part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.
  participant_user_id
  string — The participant's universally unique identifier (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "user_id": "",
        "participant_user_id": "",
        "email": "",
        "qos": [
          {
            "date_time": "",
            "type": "audio_input",
            "details": {
              "bitrate": "",
              "latency": "",
              "jitter": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm",
              "network_notification": "network bandwidth low"
            }
          }
        ]
      }
    }
  }
}

Webinar.participant_data_summaryEvent

Type:object

event (required)
string, possible values: "webinar.participant_data_summary" — 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.
- object (required)
  object
  participant (required)
  object
  data (required)
  array
  Items:
  as_internal_ip_address (required)
  string — The sharing internal IP address.
  as_internal_ip_port (required)
  string — The sharing internal IP port.
  audio_internal_ip_address (required)
  string — The audio internal IP address.
  audio_internal_ip_port (required)
  string — The audio internal IP port.
  camera (required)
  string — The camera, such as "Integrated Camera".
  connection_type (required)
  string — The connection type, such as "UDP".
  data_center (required)
  string — The data center, such as "SC (Sub)".
  destination_ip_domain (required)
  string — The destination internal IP domain.
  destination_ip_port (required)
  string — The destination internal IP port.
  device (required)
  string, possible values: "Windows", "Mac", "Phone"
  domain (required)
  string
  harddisk_id (required)
  string — The hard disk ID.
  location (required)
  string — The participant's location, formatted as "city (country code)", such as "Sunnyvale (US)".
  mac_addr (required)
  string — The MAC address, only available for the Windows client.
  microphone (required)
  string — The microphone, such as "External Microphone (External Microphone)".
  network_type (required)
  string, possible values: "Wired", "Wifi", "PPP", "3G", "Others"
  pc_name (required)
  string
  signaling_internal_ip_address (required)
  string — The signaling internal IP address.
  signaling_internal_ip_port (required)
  string — The signaling internal IP port.
  signaling_ip_address (required)
  string — The signaling IP address for information other than audio, video, or screen sharing.
  speaker (required)
  string — The headphones, such as "External Headphones (External Headphones)".
  version (required)
  string
  video_internal_ip_address (required)
  string — The video internal IP address.
  video_internal_ip_port (required)
  string — The video internal IP port.
  rc_reason
  string — The reason for call reconnection, such as "Client crash".
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — The participant ID.
  email
  string, format: email — The participant's email address. This field only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/using-zoom-apis/#email-address-display-rules) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — The webinar ID.

Example:

{
  "event": "webinar.participant_data_summary",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "Windows",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Webinar.participant_qosEvent

Type:object

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — Timestamp in milliseconds since epoch when the event occurred. The value is returned in long (int64) format.
payload (required)
object
- account_id (required)
  string — The Account ID associated with the event.
- object (required)
  object — Meeting object.
  participant (required)
  object — Participant object.
  qos (required)
  array — An array of Quality of Service (QoS) data.
  Items:
  date_time (required)
  string — The timestamp for when the participant left.
  details (required)
  object — Quality of Service (QoS) details object.
  avg_loss
  string — The average amount of packet loss, displayed as the percentage of packets that failed to arrive at their destination.
  avg_rssi
  string — Average value of the wireless network's received signal strength indicator (RSSI).
  bitrate
  string — The number of bits per second that can be transmitted along a digital network, in Kbps.
  frame_rate
  string — The rate at which your video camera can produce unique images, or frames. Zoom supports a frame rate of up to 30 frames per second (FPS).
  jitter
  string — The variation in the delay of received packets, in milliseconds.
  latency
  string — The amount of time it takes for a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss, displayed as the maximum percentage of packets that failed to arrive at their destination.
  max_rssi
  string — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_rssi
  string — Minimum value of the wireless network's received signal strength indicator (RSSI).
  network_notification
  string, possible values: "network bandwidth low", "internet connection unstable" — Client-triggered network instability notification.
  quality
  object
  quality_score
  string — The quality score value.
  resolution
  string — The number of pixels in each dimension that can be displayed by your video camera.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — System's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi", "notification" — Quality of Service (QoS) type.
  user_id (required)
  string — The participant's unique identifier.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is not part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
  participant_user_id
  string — The participant's universally unique identifier (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID).

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "user_id": "",
        "participant_user_id": "",
        "email": "",
        "qos": [
          {
            "date_time": "",
            "type": "audio_input",
            "details": {
              "bitrate": "",
              "latency": "",
              "jitter": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": null,
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm",
              "network_notification": "network bandwidth low"
            }
          }
        ]
      }
    }
  }
}

Session.user_qos_summaryEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id
  string — The unique session identifier. Each session instance has its own session ID.
  session_key
  string — The Video SDK custom session ID.
  session_name
  string — The session's name.
  user
  object — Information about the user.
  id (required)
  string — The user's unique ID assigned upon joining the session, valid only for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name (required)
  string — The user's username.
  qos (required)
  array — Information about the user's quality of service (QoS).
  Items:
  details (required)
  object
  avg_bitrate
  string — The average bits per second transmitted along a digital network, in Kbps.
  avg_frame_rate
  string — The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  avg_jitter
  string — The average variation in the delay of received packets, in milliseconds.
  avg_latency
  string — The average time it took a packet to travel from one point to another, in milliseconds.
  avg_loss
  string — The average amount of packet loss as a percentage of packets that failed to arrive at their destination.
  avg_rssi
  integer — Average value of the wireless network's received signal strength indicator (RSSI).
  max_bitrate
  string — The maximum bits per second transmitted along a digital network, in Kbps.
  max_frame_rate
  string — The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  max_jitter
  string — The maximum variation in the delay of received packets, in milliseconds.
  max_latency
  string — The maximum time it took a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss as a percentage of packets that failed to arrive at their destination.
  max_rssi
  integer — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_bitrate
  string — The minimum bits per second transmitted along a digital network, in Kbps.
  min_frame_rate
  string — The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  min_jitter
  string — The minimum variation in the delay of received packets, in milliseconds.
  min_latency
  string — The minimum time it took a packet to travel from one point to another, in milliseconds.
  min_loss
  string — The minimum amount of packet loss as a percentage of packets that failed to arrive at their destination.
  min_rssi
  integer — Minimum value of the wireless network's received signal strength indicator (RSSI).
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality assessment.
  quality_score
  string — The session quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi" — The QoS type.
  user_key
  string — An additional identifier for the user. Can be numeric or alphanumeric.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "qos": [
          {
            "type": "audio_input",
            "details": {
              "min_bitrate": "",
              "avg_bitrate": "",
              "max_bitrate": "",
              "min_latency": "",
              "avg_latency": "",
              "max_latency": "",
              "min_jitter": "",
              "avg_jitter": "",
              "max_jitter": "",
              "min_loss": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "min_frame_rate": "",
              "avg_frame_rate": "",
              "max_frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm"
            }
          }
        ]
      }
    }
  }
}

Webinar.participant_qos_summaryEvent

Type:object

event (required)
string, possible values: "webinar.participant_qos_summary" — The event's name.
event_ts (required)
integer, format: int64 — The timestamp in milliseconds since epoch when the event occurred, in long (int64) format.
payload (required)
object
- account_id (required)
  string
- object (required)
  object
  id
  string — The webinar number.
  participant
  object
  email (required)
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.
  id (required)
  string — The participant's universally unique identifier (UUID): * If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/users/#tag/users/get/users/{userId}) API response. * If the participant joins the meeting **without** logging into Zoom, this returns an empty ("") value.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  qos (required)
  array
  Items:
  details (required)
  object
  avg_bitrate
  string — The average bits per second transmitted along a digital network, in Kbps.
  avg_frame_rate
  string — The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  avg_jitter
  string — The average variation in the delay of received packets, in milliseconds.
  avg_latency
  string — The average time it took a packet to travel from one point to another, in milliseconds.
  avg_loss
  string — The average amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  avg_rssi
  integer — The average value of the wireless network's received signal strength indicator (RSSI).
  max_bitrate
  string — The maximum bits per second transmitted along a digital network, in Kbps.
  max_frame_rate
  string — The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  max_jitter
  string — The maximum variation in the delay of received packets, in milliseconds.
  max_latency
  string — The maximum time it took a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  max_rssi
  integer — The maximum value of the wireless network's received signal strength indicator (RSSI).
  min_bitrate
  string — The minimum bits per second transmitted along a digital network, in Kbps.
  min_frame_rate
  string — The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  min_jitter
  string — The minimum variation in the delay of received packets, in milliseconds.
  min_latency
  string — The minimum time it took a packet to travel from one point to another, in milliseconds.
  min_loss
  string — The minimum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  min_rssi
  integer — The minimum value of the wireless network's received signal strength indicator (RSSI).
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality object.
  quality_score
  string — The meeting quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — The unit of measurement for the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi"
  user_name (required)
  string — The participant's display name.
  uuid
  string — The webinar's universally unique identifier (UUID).

Example:

{
  "event": "webinar.participant_qos_summary",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "id": "",
      "participant": {
        "participant_id": "",
        "user_name": "",
        "id": "",
        "email": "",
        "qos": [
          {
            "type": "audio_input",
            "details": {
              "min_bitrate": "",
              "avg_bitrate": "",
              "max_bitrate": "",
              "min_latency": "",
              "avg_latency": "",
              "max_latency": "",
              "min_jitter": "",
              "avg_jitter": "",
              "max_jitter": "",
              "min_loss": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "min_frame_rate": "",
              "avg_frame_rate": "",
              "max_frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-75",
              "avg_rssi": "-69",
              "min_rssi": "-35",
              "rssi_unit": "dBm"
            }
          }
        ]
      }
    }
  }
}

Meeting.participant_dataEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — A timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  participant (required)
  object — Information about the meeting participant.
  data (required)
  array — The participant's data information.
  Items:
  as_internal_ip_address
  string — The participant's sharing internal IP address.
  as_internal_ip_port
  string — The participant's sharing internal IP port.
  audio_internal_ip_address
  string — The participant's audio internal IP address.
  audio_internal_ip_port
  string — The participant's audio internal IP port.
  camera
  string — The type of camera that the participant used during the meeting.
  connection_type
  string — The participant's connection type.
  data_center
  string — The data center where participant's meeting data is stored.
  destination_ip_domain
  string — The participant's destination internal IP domain.
  destination_ip_port
  string — The participant's destination internal IP port.
  device
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the participant used to join the meeting: * `Phone` — The participant joined via PSTN. * `H.323/SIP` — The participant joined via an H.323 or SIP device. * `Windows` — The participant joined via VoIP using a Windows device. * `Mac` — The participant joined via VoIP using a Mac device. * `iOS` — The participant joined via VoIP using an iOS device. * `Android` — The participant joined via VoIP using an Android device.
  domain
  string — The participant's PC domain.
  harddisk_id
  string — The participant's hard disk ID.
  location
  string — The participant's location.
  Location
  string — Deprecated, use `location`.
  mac_addr
  string — The participant's MAC address.
  microphone
  string — The type of microphone that the participant used during the meeting.
  network_type
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The participant's network type: * `Wired` * `Wifi` * `PPP` — Point-to-Point. * `Cellular` — 3G, 4G, and 5G cellular. * `Others` — An unknown device.
  pc_name
  string — The participant's PC name.
  rc_reason
  string — The call reconnection reason: Client crash.
  signaling_internal_ip_address
  string — The participant's signaling internal IP address.
  signaling_internal_ip_port
  string — The participant's signaling internal IP port.
  signaling_ip_address
  string — The participant's signaling IP address for information other than audio, video, or share screen.
  speaker
  string — The type of speaker that the participant used during the meeting.
  version
  string — The participant's Zoom client version.
  video_internal_ip_address
  string — The participant's video internal IP address.
  video_internal_ip_port
  string — The participant's video internal IP port.
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Phone.call_qosEvent

Type:object

event (required)
string, possible values: "phone.call_qos" — Name of the event.
event_ts (required)
integer, format: int64 — Timestamp when the event occurred, in milliseconds since epoch. 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 object type.
  call_id (required)
  string — The call ID.
  call_qos (required)
  object — The call quality of service (QoS).
  id (required)
  string — The caller or callee's ID.
  qos (required)
  object — The quality of service (QoS) data.
  date_time (required)
  string, format: date-time — The date and time when the QoS data was received.
  details (required)
  object — The quality of service (QoS) details.
  avg_loss (required)
  string — The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.
  bitrate (required)
  string — The bits per second transmitted along a digital network, in Kbsp.
  jitter (required)
  string — The variation in the delay of received packets, in milliseconds.
  max_loss (required)
  string — The maximum amount of packet loss. For example, the maximum percentage of packets that failed to arrive at their destination.
  mos (required)
  string — The Mean Opinion Score (MOS). This measures voice quality on a scale of 1 to 5. A score above or equal to 3.5 means good quality, while below 3.5 means poor quality.
  network_delay (required)
  string — The amount of time, in milliseconds, that it takes for a Voice Over IP (VoIP) packet to travel from one point to another.
  network
  string — The type of networks such as LAN, WiFi, VPN etc
  type (required)
  string — The QoS type: sending or receiving.
  type (required)
  string — The type: caller or callee.
  user_email
  string — The caller or callee's email address.
  call_start_time (required)
  string, format: date-time — The date and time when the call started.
  call_end_time
  string, format: date-time — The date and time when the call ended. Only shows up if the call ended.

Example:

{
  "event": "phone.call_qos",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "call_id": "",
      "call_start_time": "",
      "call_end_time": "",
      "call_qos": {
        "type": "",
        "id": "",
        "user_email": "",
        "qos": {
          "date_time": "",
          "type": "",
          "details": {
            "bitrate": "",
            "avg_loss": "",
            "max_loss": "",
            "jitter": "",
            "network_delay": "",
            "mos": "",
            "network": ""
          }
        }
      }
    }
  }
}

Session.user_dataEvent

Type:object

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — The timestamp when the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id (required)
  string — A unique session identifier. Each instance of the session will have its own `session_id`.
  session_name (required)
  string — The session name.
  user (required)
  object — Information about the session user.
  data (required)
  array — The user's session data.
  Items:
  as_internal_ip_address
  string — The user's sharing internal IP address.
  as_internal_ip_port
  string — The user's sharing internal IP port.
  audio_internal_ip_address
  string — The user's audio internal IP address.
  audio_internal_ip_port
  string — The user's audio internal IP port.
  camera
  string — The type of camera that the user used during the session.
  connection_type
  string — The user's connection type.
  data_center
  string — The data center where the user's session data is stored.
  destination_ip_domain
  string — The user's destination internal IP domain.
  destination_ip_port
  string — The user's destination internal IP port.
  device
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the user used to join the session. * `Phone` - The user joined via PSTN. * `H.323/SIP` - The user joined via an H.323 or SIP device. * `Windows` - The user joined via VoIP using a Windows device. * `Mac` - The user joined via VoIP using a macOS device. * `iOS` - The user joined via VoIP using an iOS device. * `Android` - The user joined via VoIP using an Android device.
  domain
  string — The user's PC domain.
  harddisk_id
  string — The user's hard disk ID.
  location
  string — The user's location.
  mac_addr
  string — The user's MAC address.
  microphone
  string — The type of microphone that the user used during the session.
  network_type
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The user's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown device.
  pc_name
  string — The user's PC name.
  rc_reason
  string — The call reconnection reason, such as a client crash.
  signaling_internal_ip_address
  string — The user's signaling internal IP address.
  signaling_internal_ip_port
  string — The user's signaling internal IP port.
  signaling_ip_address
  string — The user's signaling IP address for information other than audio, video, or screen sharing.
  speaker
  string — The type of speaker that the user used during the session.
  version
  string — The user's Zoom client version.
  video_internal_ip_address
  string — The user's video internal IP address.
  video_internal_ip_port
  string — The user's video internal IP port.
  id (required)
  string — The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name
  string — The user's username.
  user_key
  string — Another identifier for the user. The value can be numeric or alphanumeric.
  session_key
  string — The Video SDK custom session ID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Meeting.participant_data_summaryEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  participant (required)
  object — Information about the meeting participant.
  data (required)
  array — The participant's data details.
  Items:
  as_internal_ip_address (required)
  string — The participant's sharing internal IP address.
  as_internal_ip_port (required)
  string — The participant's sharing internal IP port.
  audio_internal_ip_address (required)
  string — The participant's audio internal IP address.
  audio_internal_ip_port (required)
  string — The participant's audio internal IP port.
  camera (required)
  string — The type of camera that the participant used during the meeting.
  connection_type (required)
  string — The participant's connection type.
  data_center (required)
  string — The data center where the participant's meeting data is stored.
  destination_ip_domain (required)
  string — The participant's destination internal IP domain.
  destination_ip_port (required)
  string — The participant's destination internal IP port.
  device (required)
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the participant used to join the meeting: * `Phone` — The participant joined via PSTN. * `H.323/SIP` — The participant joined via an H.323 or SIP device. * `Windows` — The participant joined via VoIP using a Windows device. * `Mac` — The participant joined via VoIP using a Mac device. * `iOS` — The participant joined via VoIP using an iOS device. * `Android` — The participant joined via VoIP using an Android device.
  domain (required)
  string — The participant's PC domain.
  harddisk_id (required)
  string — The participant's hard disk ID.
  location (required)
  string — The participant's location.
  mac_addr (required)
  string — The participant's MAC address.
  microphone (required)
  string — The type of microphone that the participant used during the meeting.
  network_type (required)
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The participant's network type: * `Wired` * `Wifi` * `PPP` — Point-to-Point. * `Cellular` — 3G, 4G, and 5G cellular. * `Others` — An unknown device.
  pc_name (required)
  string — The participant's PC name.
  signaling_internal_ip_address (required)
  string — The participant's signaling internal IP address.
  signaling_internal_ip_port (required)
  string — The participant's signaling internal IP port.
  signaling_ip_address (required)
  string — The participant's signaling IP address for information other than audio, video, or screen sharing.
  speaker (required)
  string — The type of speaker that the participant used during the meeting.
  version (required)
  string — The participant's Zoom client version.
  video_internal_ip_address (required)
  string — The participant's video internal IP address.
  video_internal_ip_port (required)
  string — The participant's video internal IP port.
  client
  string — The participant's SDK client version.
  device_detail
  string — The participant's detailed device information.
  rc_reason
  string — The call reconnection reason, for example, `Client crash`.
  zoom_thin_client_plugin_version
  string — The VDI thin client version.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting.
  email
  string, format: email — The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.
  participant_user_id
  string — The participant's universally unique ID (UUID). Returns an empty value for external users.
  uuid (required)
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID.
  id
  string — The meeting ID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "id": "",
      "participant": {
        "participant_id": "",
        "participant_user_id": "",
        "email": "",
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "device_detail": "",
            "client": "",
            "zoom_thin_client_plugin_version": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Session.user_data_summaryEvent

Type:object

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id (required)
  string — A unique session identifier. Each instance of the session will have its own `session_id`.
  session_name (required)
  string — Session name.
  user (required)
  object — Information about the session user.
  data (required)
  array — The user's session data.
  Items:
  as_internal_ip_address (required)
  string — The user's sharing internal IP address.
  as_internal_ip_port (required)
  string — The user's sharing internal IP port.
  audio_internal_ip_address (required)
  string — The user's audio internal IP address.
  audio_internal_ip_port (required)
  string — The user's audio internal IP port.
  camera (required)
  string — The type of camera that the user used during the session.
  connection_type (required)
  string — The user's connection type.
  data_center (required)
  string — The data center where the user's session data is stored.
  destination_ip_domain (required)
  string — The user's destination internal IP domain.
  destination_ip_port (required)
  string — The user's destination internal IP port.
  device (required)
  string, possible values: "Phone", "H.323/SIP", "Windows", "Mac", "iOS", "Android" — The type of device the user used to join the session. * `Phone` - The user joined via PSTN. * `H.323/SIP` - The user joined via an H.323 or SIP device. * `Windows` - The user joined via VoIP using a Windows device. * `Mac` - The user joined via VoIP using a macOS device. * `iOS` - The user joined via VoIP using an iOS device. * `Android` - The user joined via VoIP using an Android device.
  domain (required)
  string — The user's PC domain.
  harddisk_id (required)
  string — The user's hard disk ID.
  location (required)
  string — The user's location.
  mac_addr (required)
  string — The user's MAC address.
  microphone (required)
  string — The type of microphone that the user used during the session.
  network_type (required)
  string, possible values: "Wired", "Wifi", "PPP", "Cellular", "Others" — The user's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown network type.
  pc_name (required)
  string — The user's PC name.
  signaling_internal_ip_address (required)
  string — The user's signaling internal IP address.
  signaling_internal_ip_port (required)
  string — The user's signaling internal IP port.
  signaling_ip_address (required)
  string — The user's signaling IP address for information other than audio, video, or screen sharing.
  speaker (required)
  string — The type of speaker that the user used during the session.
  version (required)
  string — The user's Zoom client version.
  video_internal_ip_address (required)
  string — The user's video internal IP address.
  video_internal_ip_port (required)
  string — The user's video internal IP port.
  client
  string — The user's SDK client version.
  device_detail
  string — The user's detailed device information.
  rc_reason
  string — The reason for call reconnection, such as a client crash.
  id (required)
  string — The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name
  string — The user's username.
  user_key
  string — Another identifier for the user. Can be numeric or alphanumeric.
  session_key
  string — The Video SDK custom session ID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "data": [
          {
            "device": "Phone",
            "location": "",
            "network_type": "Wired",
            "microphone": "",
            "speaker": "",
            "camera": "",
            "data_center": "",
            "connection_type": "",
            "pc_name": "",
            "domain": "",
            "mac_addr": "",
            "harddisk_id": "",
            "version": "",
            "signaling_ip_address": "",
            "signaling_internal_ip_address": "",
            "signaling_internal_ip_port": "",
            "audio_internal_ip_address": "",
            "audio_internal_ip_port": "",
            "video_internal_ip_address": "",
            "video_internal_ip_port": "",
            "as_internal_ip_address": "",
            "as_internal_ip_port": "",
            "destination_ip_domain": "",
            "destination_ip_port": "",
            "device_detail": "",
            "client": "",
            "rc_reason": ""
          }
        ]
      }
    }
  }
}

Meeting.participant_qos_summaryEvent

Type:object

event (required)
string — The name of the event.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The meeting host's account ID.
- object (required)
  object — Information about the meeting.
  id
  string — The meeting ID.
  participant
  object — Information about the meeting participant.
  email (required)
  string, format: email — The participant's email address. Only returned if the participant joined the meeting by logging into Zoom.
  id (required)
  string — The participant's universally unique ID (UUID): * If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/rest/reference/zoom-api/methods/#operation/user) API response. * If the participant joins the meeting **without** logging into Zoom, this returns an empty (`""`) value.
  participant_id (required)
  string — The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting duration.
  qos (required)
  array — Information about the participant's quality of service (QoS).
  Items:
  details (required)
  object
  avg_bitrate
  string — The average bits per second transmitted along a digital network, in Kbps.
  avg_frame_rate
  string — The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  avg_jitter
  string — The average variation in the delay of received packets, in milliseconds.
  avg_latency
  string — The average time it took a packet to travel from one point to another, in milliseconds.
  avg_loss
  string — The average amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  avg_rssi
  integer — The average value of the wireless network's received signal strength indicator (RSSI).
  max_bitrate
  string — The maximum bits per second transmitted along a digital network, in Kbps.
  max_frame_rate
  string — The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  max_jitter
  string — The maximum variation in the delay of received packets, in milliseconds.
  max_latency
  string — The maximum time it took a packet to travel from one point to another, in milliseconds.
  max_loss
  string — The maximum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  max_rssi
  integer — The maximum value of the wireless network's received signal strength indicator (RSSI).
  min_bitrate
  string — The minimum bits per second transmitted along a digital network, in Kbps.
  min_frame_rate
  string — The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS).
  min_jitter
  string — The minimum variation in the delay of received packets, in milliseconds.
  min_latency
  string — The minimum time it took a packet to travel from one point to another, in milliseconds.
  min_loss
  string — The minimum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination.
  min_rssi
  integer — The minimum value of the wireless network's received signal strength indicator (RSSI).
  quality
  string, possible values: "bad", "fair", "good", "poor" — Meeting Quality Object
  quality_score
  string — The meeting quality score.
  resolution
  string — The number of pixels in each dimension that the video camera can display.
  rssi_unit
  string — The unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi" — The type of quality of service (QoS) metrics, from the point of view of the client. See [List meeting participants QoS Summary](https://developers.zoom.us/docs/api/rest/reference/qss/methods/#operation/dashboardMeetingParticipantsQOSSummary) for descriptions.
  user_name (required)
  string — The participant's display name.
  uuid
  string — The meeting's universally unique identifier (UUID). Each meeting instance generates a unique meeting UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "uuid": "",
      "id": "",
      "participant": {
        "participant_id": "",
        "user_name": "",
        "id": "",
        "email": "",
        "qos": [
          {
            "type": "audio_input",
            "details": {
              "min_bitrate": "",
              "avg_bitrate": "",
              "max_bitrate": "",
              "min_latency": "",
              "avg_latency": "",
              "max_latency": "",
              "min_jitter": "",
              "avg_jitter": "",
              "max_jitter": "",
              "min_loss": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "min_frame_rate": "",
              "avg_frame_rate": "",
              "max_frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm"
            }
          }
        ]
      }
    }
  }
}

Session.user_qosEvent

Type:object

event (required)
string — The event's name.
event_ts (required)
integer, format: int64 — The timestamp at which the event occurred.
payload (required)
object
- account_id (required)
  string — The Video SDK account ID.
- object (required)
  object — Information about the session.
  session_id (required)
  string — The unique session identifier. Each instance of the session will have its own session_id.
  session_name (required)
  string — The session name.
  user (required)
  object — Information about the user.
  id (required)
  string — The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session.
  is_original_host (required)
  boolean — Whether the current user is the original host of this session.
  name (required)
  string — The user's username.
  qos (required)
  array — Information about the user's quality of service (QoS).
  Items:
  date_time (required)
  string — The timestamp when the QoS data was recorded.
  details (required)
  object — The QoS details object.
  avg_loss
  string — The average packet loss percentage.
  avg_rssi
  string — Average value of the wireless network's received signal strength indicator (RSSI).
  bitrate
  string — The transmission rate in kilobits per second (Kbps) along the digital network.
  frame_rate
  string — The rate at which the camera produces unique frames. Zoom supports up to 30 frames per second (FPS).
  jitter
  string — The variation in the delay of received packets, in milliseconds.
  latency
  string — The time it takes for a packet to travel from one point to another, measured in milliseconds.
  max_loss
  string — The maximum packet loss percentage.
  max_rssi
  string — Maximum value of the wireless network's received signal strength indicator (RSSI).
  min_rssi
  string — Minimum value of the wireless network's received signal strength indicator (RSSI).
  network_notification
  string, possible values: "network bandwidth low", "internet connection unstable" — Client-triggered network instability notification.
  quality
  string, possible values: "bad", "fair", "good", "poor" — The meeting quality level.
  quality_score
  string — The session quality score.
  resolution
  string — The video resolution in pixels that the camera can display.
  rssi_unit
  string — Unit of the wireless network's received signal strength indicator (RSSI).
  system_avg_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  system_max_cpu_usage
  string — The system's maximum CPU usage.
  system_min_cpu_pressure_level
  string, possible values: "normal", "fair", "serious", "critical" — The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).
  zoom_avg_cpu_usage
  string — Zoom's average CPU usage.
  zoom_max_cpu_usage
  string — Zoom's maximum CPU usage.
  zoom_min_cpu_usage
  string — Zoom's minimum CPU usage.
  type (required)
  string, possible values: "audio_input", "audio_output", "video_input", "video_output", "as_input", "as_output", "cpu_usage", "audio_device_from_crc", "audio_device_to_crc", "video_device_from_crc", "video_device_to_crc", "as_device_from_crc", "as_device_to_crc", "audio_device_from_rwg", "audio_device_to_rwg", "video_device_from_rwg", "video_device_to_rwg", "as_device_from_rwg", "as_device_to_rwg", "audio_quality", "video_quality", "as_quality", "wifi_rssi", "notification" — The QoS type. - `audio_input` — The QoS metrics for audio sent by a user. - `audio_output` — The QoS metrics for audio received by a user. - `video_input` — The QoS metrics for video input sent by a user. - `video_output` — The QoS metrics for video output received by a user. - `as_input` — The QoS metrics for screen sharing sent by a user. - `as_output` — The QoS metrics for screen sharing output received by a user. - `cpu_usage` — The QoS metrics for CPU usage. - `audio_device_from_crc` — The QoS metrics for audio sent by a user who joined the session via a Cloud Room Connector (CRC). - `audio_device_to_crc` — The QoS metrics for audio received by a user who joined the session via CRC. - `video_device_from_crc` — The QoS metrics for video input sent by a user who joined the session via CRC. - `video_device_to_crc` — The QoS metrics for video output received by a user who joined the session via CRC. - `as_device_from_crc` — The QoS metrics for screen sharing sent by a user who joined the session via CRC. - `as_device_to_crc` — The QoS metrics for screen sharing output received by a user who joined the session via CRC. - `audio_device_from_rwg` — The QoS metrics for audio sent by a participant who joined the meeting via the web client. - `audio_device_to_rwg` — The QoS metrics for audio received by a participant who joined the meeting via the web client. - `video_device_from_rwg` — The QoS metrics for video sent by a participant who joined the meeting via the web client. - `video_device_to_rwg` — The QoS metrics for video received by a participant who joined the meeting via the web client. - `as_device_from_rwg` — The QoS metrics for screen sharing sent by a participant who joined the meeting via the web client. - `as_device_to_rwg` — The QoS metrics for screen sharing received by a participant who joined the meeting via the web client. - `audio_quality` — `good`: The audio is almost flawless and the quality is excellent. `fair`: The audio occasionally has distortion, noise, or other problems, but the content is basically continuous and users can communicate normally. `poor`: The audio often has distortion, noise, or other problems, but the content is basically continuous and users can communicate normally. `bad`: The sound quality is extremely poor and the audio content is almost inaudible. - `video_quality` — `good`: The video is almost flawless and the quality is excellent. `fair`: The video definition is high and occasionally gets stuck or has other problems, but the frequency is very low and the video quality is good. `poor`: The video definition is not high, but not many problems exist. The video quality is mediocre. `bad`: The picture is very blurred and often gets stuck. - `as_quality` — `good`: The screen sharing is almost flawless and the quality is excellent. `fair`: The screen sharing definition is high and occasionally gets stuck or has other problems, but the frequency is very low and the quality is good. `poor`: The screen sharing definition is not high, but not many problems exist. The quality is mediocre. `bad`: The picture is very blurred and often gets stuck. - `wifi_rssi` — The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network. - `notification` — The notification type.
  user_key
  string — An additional identifier for the user. Can be numeric or alphanumeric.
  session_key
  string — The Video SDK custom session identifier.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "session_id": "",
      "session_name": "",
      "session_key": "",
      "user": {
        "id": "",
        "name": "",
        "user_key": "",
        "is_original_host": true,
        "qos": [
          {
            "date_time": "",
            "type": "audio_input",
            "details": {
              "bitrate": "",
              "latency": "",
              "jitter": "",
              "avg_loss": "",
              "max_loss": "",
              "resolution": "",
              "frame_rate": "",
              "zoom_min_cpu_usage": "",
              "zoom_avg_cpu_usage": "",
              "zoom_max_cpu_usage": "",
              "system_max_cpu_usage": "",
              "system_min_cpu_pressure_level": "normal",
              "system_avg_cpu_pressure_level": "normal",
              "system_max_cpu_pressure_level": "normal",
              "quality": "bad",
              "quality_score": "",
              "max_rssi": "-35",
              "avg_rssi": "-69",
              "min_rssi": "-75",
              "rssi_unit": "dBm",
              "network_notification": "network bandwidth low"
            }
          }
        ]
      }
    }
  }
}