Video SDK Master API

• bring_our_own_storage (required)

  boolean — Whether to turn on Bring Your Own Storage (BYOS) or not. Set to `true` to enable BYOS or `false` to disable it. If you disable BYOS, for security, Zoom will delete all storage location details.

• storage_location_id

  string — The ID for the selected storage location.

Content-Type: application/json

Example:

[
  {
    "id": "9lXuCXgOTIqocq81iotCdQ",
    "name": "11111",
    "provider": "aws_s3",
    "selected": true,
    "s3": {
      "region": "us-east-2",
      "bucket": "testpbx",
      "authentication_mechanism": "aws_access_key"
    }
  }
]

• name (required)

  string — The name for your storage location.

• provider (required)

  string, possible values: "aws_s3" — The provider (currently only supports `aws_s3`).

• s3 (required)

  object — Currently only supports Amazon S3 access key and secret.

  • access_key (required)

    object — When `authentication_mechanism` value is `aws_access_key`.

    • id (required)

      string — The AWS access key.

    • key (required)

      string — The AWS secret.

  • authentication_mechanism (required)

    string, possible values: "aws_access_key" — The authentication mechanism (currently only supports `aws_access_key`, which uses the S3 access key).

  • bucket (required)

    string — The Amazon S3 bucket.

  • region (required)

    string — The AWS region.

Content-Type: application/json

Example:

{
  "id": "GOSG08LQQoeDyyRAO6GgLw",
  "name": "0827aksk",
  "provider": "aws_s3",
  "s3": {
    "region": "us-east-2",
    "bucket": "testpbx",
    "authentication_mechanism": "aws_access_key"
  }
}

Content-Type: application/json

Example:

{
  "id": "7kdwg5y0Ra6B2vWdtXUJOQ",
  "name": "newpbx123",
  "provider": "aws_s3",
  "s3": {
    "region": "us-east-1",
    "bucket": "testpbx",
    "authentication_mechanism": "aws_access_key"
  },
  "verify_status": "success"
}

• name

  string — The custom name.

• provider

  string, possible values: "aws_s3" — The provider (currently only supports `aws_s3`).

• s3

  object — Currently only supports Amazon S3 access key and secret.

  • access_key

    object — When `authentication_mechanism` value is `aws_access_key`.

    • id

      string — The AWS access key. When you get or list the storage location detail, this key will be blocked.

    • key

      string — The AWS secret. When you get or list the storage location detail, this secret will be blocked.

  • authentication_mechanism

    string, possible values: "aws_access_key" — The authentication mechanism (currently only supports `aws_access_key`).

  • bucket

    string — The Amazon S3 bucket (cannot change bucket).

  • region

    string — The AWS region (cannot change region).

Content-Type: application/json

Example:

{
  "from": "2021-10-11",
  "to": "2021-11-11",
  "page_size": 30,
  "total_records": 100,
  "next_page_token": "Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82",
  "sessions": [
    {
      "session_id": "JZiFOknTQ4yH/tJgaUTlkg==",
      "session_name": "session_name",
      "start_time": "2022-03-10T02:27:24Z",
      "duration": 2,
      "total_size": 444601,
      "recording_count": 4,
      "session_key": "ABC36jaBI145",
      "recording_files": [
        {
          "id": "35497738-9fef-4f8a-97db-0ec34caef065",
          "recording_start": "2022-03-11T12:34:39Z",
          "recording_end": "2022-03-11T12:34:42Z",
          "file_type": "MP4",
          "file_size": 12125,
          "download_url": "https://example.com/download_url",
          "external_storage_url": "s3://cmrpbx/cmr/replay/2024/05/01/77431195-02EC-4B4C-8218-17E716123FCD/cmr_byos/GMT20210906-041233_Recording.m4a",
          "status": "completed",
          "deleted_time": "2022-03-28T07:22:22Z",
          "recording_type": "audio_only"
        }
      ],
      "participant_video_files": [
        {
          "id": "24698bd1-589e-4c33-9ba3-bc788b2a0ac2",
          "recording_start": "2021-12-07T05:42:13Z",
          "recording_end": "2021-12-07T05:42:28Z",
          "file_name": "recording_name",
          "file_type": "MP4",
          "file_extension": "MP4",
          "file_size": 900452,
          "download_url": "https://download.example.com/download_url",
          "recording_type": "individual_shared_screen",
          "status": "completed",
          "user_id": "abcd1234",
          "user_key": "efgh5678"
        }
      ]
    }
  ]
}

Content-Type: application/json

Example:

{
  "session_id": "JZiFOknTQ4yH/tJgaUTlkg==",
  "session_name": "session_name",
  "start_time": "2022-03-10T02:27:24Z",
  "duration": 2,
  "total_size": 444601,
  "recording_count": 4,
  "session_key": "ABC36jaBI145",
  "recording_files": [
    {
      "id": "35497738-9fef-4f8a-97db-0ec34caef065",
      "recording_start": "2022-03-11T12:34:39Z",
      "recording_end": "2022-03-11T12:34:42Z",
      "file_type": "MP4",
      "file_size": 12125,
      "download_url": "https://example.com/download_url",
      "external_storage_url": "s3://cmrpbx/cmr/replay/2024/05/01/77431195-02EC-4B4C-8218-17E716123FCD/cmr_byos/GMT20210906-041233_Recording.m4a",
      "status": "completed",
      "deleted_time": "2022-03-28T07:22:22Z",
      "recording_type": "audio_only"
    }
  ],
  "participant_video_files": [
    {
      "id": "24698bd1-589e-4c33-9ba3-bc788b2a0ac2",
      "recording_start": "2021-12-07T05:42:13Z",
      "recording_end": "2021-12-07T05:42:28Z",
      "file_name": "recording_name",
      "file_type": "MP4",
      "file_extension": "MP4",
      "file_size": 900452,
      "download_url": "https://download.example.com/download_url",
      "recording_type": "individual_shared_screen",
      "status": "completed",
      "user_id": "abcd1234",
      "user_key": "efgh5678"
    }
  ],
  "download_access_token": "exampleTokenXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "participant_audio_files": [
    {
      "id": "24698bd1-589e-4c33-9ba3-bc788b2a0ac2",
      "recording_start": "2021-12-07T05:42:13Z",
      "recording_end": "2021-12-07T05:42:28Z",
      "file_name": "recording_name",
      "file_type": "MP4",
      "file_extension": "MP4",
      "file_size": 900452,
      "download_url": "https://download.example.com/download_url",
      "status": "completed",
      "user_id": "abcd1234",
      "user_key": "efgh5678"
    }
  ]
}

• action

  string, possible values: "recover" — The action to perform.

• action

  string, possible values: "recover"

Content-Type: application/json

Example:

{
  "from": "2021-12-01",
  "to": "2021-12-02",
  "page_size": 30,
  "next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2",
  "sessions": [
    {
      "id": "sfk/aOFJSJSYhGwk1hnxgw==",
      "session_name": "My session",
      "start_time": "2019-08-20T19:09:01Z",
      "end_time": "2019-08-20T19:19:01Z",
      "duration": "30:00",
      "user_count": 2,
      "has_voip": true,
      "has_video": true,
      "has_screen_share": true,
      "has_recording": true,
      "has_pstn": true,
      "session_key": "my_session_key",
      "has_session_summary": true,
      "audio_quality": "good",
      "video_quality": "good",
      "screen_share_quality": "good"
    }
  ]
}

• session_name (required)

  string — The session's name.

• session_password

  string — Developer provided session alphanumeric password. It is equivalent to the sessionPassword in the Video SDK interface.

• settings

  object — Information about the session's settings.

  • auto_recording

    string, possible values: "cloud", "none", default: "none" — The automatic recording settings. * `cloud` - Record the session to the cloud. * `none` - Auto-recording disabled.

  • hold

    integer, possible values: 0, 1, 2, default: 0 — The session's hold setting. * `0` - Hold is disabled. Older SDK clients are allowed to join. * `1` - Hold is enabled. Non-host participants enter a holding state and must be admitted by the host. * `2` - Hold is supported but disabled by default. Session hosts can enable it during a session.

Content-Type: application/json

Example:

{
  "session_id": "sfk/aOFJSJSYhGwk1hnxgw==",
  "session_number": 97763643886,
  "session_name": "My session",
  "session_password": "123456",
  "passcode": "123456",
  "created_at": "2022-03-25T07:29:29Z",
  "settings": {
    "auto_recording": "cloud",
    "global_dial_in_countries": [
      "US"
    ],
    "global_dial_in_numbers": [
      {
        "country": "US",
        "country_name": "US",
        "number": "+1 1000200200",
        "type": "toll"
      }
    ],
    "hold": 0
  }
}

Content-Type: application/json

Example:

{
  "id": "sfk/aOFJSJSYhGwk1hnxgw==",
  "session_number": 97763643886,
  "session_name": "My session",
  "passcode": "123456",
  "start_time": "2019-08-20T19:09:01Z",
  "end_time": "2019-08-20T19:19:01Z",
  "duration": "30:00",
  "user_count": 2,
  "has_voip": true,
  "has_video": true,
  "has_screen_share": true,
  "has_recording": true,
  "has_pstn": true,
  "session_key": "my_session_key",
  "has_session_summary": true,
  "created_at": "2022-03-25T07:29:29Z",
  "settings": {
    "auto_recording": "cloud",
    "hold": 0,
    "global_dial_in_countries": [
      "US"
    ],
    "global_dial_in_numbers": [
      {
        "country": "US",
        "country_name": "US",
        "number": "+1 1000200200",
        "type": "toll"
      }
    ]
  },
  "audio_quality": "good",
  "video_quality": "good",
  "screen_share_quality": "good",
  "total_minutes": 1
}

• method

  string, possible values: "recording.start", "recording.stop", "recording.pause", "recording.resume", "user.invite.callout", "user.invite.room_system_callout", "stream_ingestion.bind", "stream_ingestion.unbind", "stream_ingestion.send", "stream_ingestion.stop", "audio.block", "audio.unblock", "video.block", "video.unblock", "share.block", "share.unblock", "user.remove" — The method that you would like to control. The value of this field can be one of the following. * `recording.start` - Start the recording. * `recording.stop` - Stop the recording. * `recording.pause` - Pause the recording. * `recording.resume` - Resume the recording that was previously paused. * `user.invite.callout` - Invite a user to the session through call out (phone). Requires that you purchase and set up the Audio Conferencing plan. See [Video SDK account settings](/docs/video-sdk/account/#customize-audio-conferencing) for details. * `user.invite.room_system_callout` - Invite a user to the session through call out (room system). This works like [Inviting others to join a Zoom Rooms meeting](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065721) in Zoom Meeting. See the link for details. Use these values for Real-Time Messaging Protocol (RTMP) ingestion for a live session (you must also add a `stream_ingestion_stream_id` to the request). * `stream_ingestion.bind` - Bind a stream key to a session. * `stream_ingestion.unbind` - Unbind a stream key to a session. You can bind the unbound stream key to another live session. * `stream_ingestion.send` - Send ingested stream data into a session. * `stream_ingestion.stop` - Stop sending ingested stream data into a session. Contact [Developer Support](https://developers.zoom.us/support/) to enable the following moderation features. * `audio.block` - Mute the user's audio and disallow self-unmute. * `audio.unblock` - Allow users to unmute themselves. * `video.block` - Stop the user's video and disallow self-starting. * `video.unblock` - Allow users to start the video themselves. * `share.block` - Stop the user's share and disallow self-starting. * `share.unblock` - Allow users to start sharing themselves. * `user.remove` - Remove a user from a session.

• params

  object — The in-session parameters.

  • call_type

    string — The type of call out. Use a value of `h323` or `sip`. Use this field if you pass the `user.invite.room_system_callout` value for the `method` field.

  • device_ip

    string — The user's device IP address. Use this field if you pass the `user.invite.room_system_callout` value for the `method` field.

  • h323_headers

    object — Enable customers to leverage services that require customization of the FROM header to identify the caller. Use this field if you pass the `user.invite.room_system_callout` value for the `method` field and the `h323` value for the `call_type` field.

    • from_display_name

      string — Custom name that will be used within the `h323` header.

    • to_display_name

      string — Custom remote name that will be used within the session.

  • invite_options

    object — Information about the `user.invite.callout` settings.

    • require_greeting

      boolean, default: true — Whether to require a greeting before being connected. Use this field if you pass the `user.invite.callout` value for the `method` field.

    • require_pressing_one

      boolean, default: true — Whether to require pressing 1 before being connected. Use this field if you pass the `user.invite.callout` value for the `method` field.

  • invitee_name

    string — The user's name to display in the session. Use this field if you pass the `user.invite.callout` value for the `method` field.

  • participant_uuid

    string — The user's UUID. This value is assigned to a user upon joining a session and is only valid for the session's duration. Use this field if you pass the `audio.block`, `audio.unblock`, `video.block`, `video.unblock`, `share.block`, `share.unblock`, or `user.remove` value for the `method` field.

  • phone_number

    string — The user's phone number. Use this field if you pass the `user.invite.callout` value for the `method` field. As a best practice, ensure this includes a country code and area code. If you are dialing a phone number that includes an extension, type a hyphen '-' after the phone number and enter the extension. For example, 6032331333-156 dials the extension 156.

  • sip_headers

    object — Enable customers to leverage services that require customization of the FROM header to identify the caller. Use this field if you pass the `user.invite.room_system_callout` value for the `method` field and the `sip` value for the `call_type` field.

    • additional_headers

      array — Ability to add 1..10 custom headers, each of which has a maximum length of 256 bytes to comply with SIP standards. Custom headers would leverage header names starting with "X-" per SIP guidelines.

      Items:

      • key

        string — Additional custom SIP header's key

      • value

        string — Additional custom SIP header's value

    • from_display_name

      string — Custom name that will be used within the SIP Header.

    • from_uri

      string — Custom URI that will be used within the SIP Header. The URI must be start with 'sip:' or 'sips:' as a valid URI based on parameters defined by the platform

    • to_display_name

      string — Custom remote name that will be used within the session.

  • stream_ingestion_stream_id

    string — The stream ingestion ID. Use this field if you pass the `stream_ingestion.bind`, `stream_ingestion.unbind`, `stream_ingestion.send`, or `stream_ingestion.stop` value for the `method` field.

Content-Type: application/json

Example:

{
  "stream_url": "https://example.com/livestream",
  "stream_key": "ABCDEFG12345HIJ6789",
  "page_url": "https://example.com/livestream/123",
  "resolution": "720p"
}

• page_url (required)

  string, format: url — The live stream's page URL. This is the URL at which anyone can view the session's live stream.

• stream_key (required)

  string — The live stream key.

• stream_url (required)

  string, format: url — The live stream's URL.

• resolution

  string — The number of pixels in each dimension that the video camera can display, required when a user enables 1080p. Use a value of `720p` or `1080p`

• action

  string, possible values: "start", "stop", "mode" — The session's livestream status: * `start` - Start a livestream. * `stop` - Stop an ongoing livestream. * `mode` - Control a livestream view at runtime.

• settings

  object — The session's livestreaming settings.

  • active_speaker_name

    boolean — Whether to display the name of the active speaker during a session's livestream. Use this field if you pass the `start` value for the `action` field.

  • close_caption

    string, possible values: "burnt-in", "embedded", "off", default: "burnt-in" — The closed caption type of the session's livestream. Use this field if you pass the `start` or `mode` value for the `action` field. * `burnt-in` - Burnt-In Captions. * `embedded` - Embedded Captions. * `off` - Turn off Captions.

  • display_name

    string — The display name of the session's livestream. Use this field if you pass the `start` value for the `action` field.

  • layout

    string, possible values: "gallery_view", "speaker_view", default: "speaker_view" — The layout of the session's livestream. Use this field if you pass the `start` or `mode` value for the `action` field. * `gallery_view` - Gallery view. * `speaker_view` - Speaker view.

• action

  string, possible values: "end" — The session's type: * `end` — End the session.

Content-Type: application/json

Example:

[
  {
    "stream_id": "sfk/aOFJSJSYhGwk1hnxgw==",
    "rtmp_connection_status": 0,
    "rtmp_stream_push_status": 0
  }
]

Content-Type: application/json

Example:

{
  "page_size": 30,
  "next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2",
  "users": [
    {
      "id": "32dsfsd4g5gd",
      "name": "exampleuser",
      "device": "Windows",
      "ip_address": "127.0.0.1",
      "location": "New York",
      "network_type": "Wifi",
      "microphone": "Plantronics BT600",
      "speaker": "Plantronics BT600",
      "camera": "FaceTime HD Camera",
      "data_center": "SC",
      "connection_type": "P2P",
      "join_time": "2019-08-20T19:09:01Z",
      "leave_time": "2019-08-20T19:19:01Z",
      "user_key": "myUserKey",
      "audio_call": [
        {
          "call_number": "4131",
          "call_type": "call-in",
          "zoom_number": "18773690926"
        }
      ],
      "participant_uuid": "D444CD06-2ABB-2FCC-019B-39E41D8DADF7",
      "client": "Web Meeting SDK 2.18",
      "os": "iOS",
      "os_version": "16.5",
      "browser_name": "Firefox",
      "browser_version": "133",
      "audio_quality": "good",
      "video_quality": "good",
      "screen_share_quality": "good",
      "is_original_host": false
    }
  ]
}

Content-Type: application/json

Example:

{
  "page_size": 1,
  "next_page_token": "1cyhUewZa419P9F8QUYURck0U3rFWB0d1H2",
  "users": [
    {
      "id": "1670000000",
      "name": "User",
      "device": "Android",
      "client": "Web Meeting SDK 2.18",
      "os": "iOS",
      "os_version": "16.5",
      "browser_name": "Firefox",
      "browser_version": "133",
      "ip_address": "192.0.2.0",
      "location": "San Jose (US)",
      "network_type": "Wifi",
      "microphone": "Plantronics BT600",
      "speaker": "Plantronics BT600",
      "camera": "FaceTime HD Camera",
      "data_center": "SC",
      "connection_type": "P2P",
      "join_time": "2019-08-20T19:09:01Z",
      "leave_time": "2019-08-20T19:19:01Z",
      "user_key": "myUserKey",
      "is_original_host": false,
      "user_qos": [
        {
          "date_time": "2019-08-20T19:19:01Z",
          "audio_input": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%"
          },
          "audio_output": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%"
          },
          "video_input": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "video_output": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "as_input": {
            "bitrate": "23 Kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "as_output": {
            "bitrate": "23 Kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "audio_device_from_rwg": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%"
          },
          "audio_device_to_rwg": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%"
          },
          "video_device_from_rwg": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "video_device_to_rwg": {
            "bitrate": "23 kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "as_device_from_rwg": {
            "bitrate": "23 Kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "as_device_to_rwg": {
            "bitrate": "23 Kbps",
            "latency": "126 ms",
            "jitter": "6 ms",
            "avg_loss": "0.3%",
            "max_loss": "1.9%",
            "resolution": "1280*720",
            "frame_rate": "12 fps"
          },
          "wifi_rssi": {
            "max_rssi": -75,
            "avg_rssi": -69,
            "min_rssi": -35,
            "rssi_unit": "dBm"
          },
          "cpu_usage": {
            "zoom_min_cpu_usage": "8%",
            "zoom_avg_cpu_usage": "12%",
            "zoom_max_cpu_usage": "18%",
            "system_max_cpu_usage": "40%"
          },
          "cpu_pressure_level": {
            "system_min_cpu_pressure_level": "normal",
            "system_avg_cpu_pressure_level": "normal",
            "system_max_cpu_pressure_level": "normal"
          }
        }
      ]
    }
  ]
}

Content-Type: application/json

Example:

{
  "page_size": 1,
  "next_page_token": "1cyhUewZa419P9F8QUYURck0U3rFWB0d1H2",
  "users": [
    {
      "id": "1670000000",
      "name": "User",
      "user_key": "myUserKey",
      "details": [
        {
          "content": "desktop",
          "start_time": "2021-06-17T06:49:06Z",
          "end_time": "2021-06-17T06:49:35Z"
        }
      ]
    }
  ]
}

Content-Type: application/json

Example:

{
  "id": "1670000000",
  "name": "User",
  "device": "Android",
  "os": "iOS",
  "os_version": "16.5",
  "browser_name": "Firefox",
  "browser_version": "133",
  "client": "Web Meeting SDK 2.18",
  "ip_address": "192.0.2.0",
  "location": "San Jose (US)",
  "network_type": "Wifi",
  "microphone": "Plantronics BT600",
  "speaker": "Plantronics BT600",
  "camera": "FaceTime HD Camera",
  "data_center": "SC",
  "connection_type": "P2P",
  "join_time": "2019-08-20T19:09:01Z",
  "leave_time": "2019-08-20T19:19:01Z",
  "user_key": "myUserKey",
  "is_original_host": false,
  "user_qos": [
    {
      "date_time": "2019-08-20T19:19:01Z",
      "audio_input": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%"
      },
      "audio_output": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%"
      },
      "video_input": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "video_output": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "as_input": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "as_output": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "audio_device_from_rwg": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%"
      },
      "audio_device_to_rwg": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%"
      },
      "video_device_from_rwg": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "video_device_to_rwg": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "as_device_from_rwg": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "as_device_to_rwg": {
        "bitrate": "23 kbps",
        "latency": "126 ms",
        "jitter": "6 ms",
        "avg_loss": "0.3%",
        "max_loss": "1.9%",
        "resolution": "1280*720",
        "frame_rate": "12 fps"
      },
      "wifi_rssi": {
        "max_rssi": -75,
        "avg_rssi": -69,
        "min_rssi": -35,
        "rssi_unit": "dBm"
      },
      "cpu_usage": {
        "zoom_min_cpu_usage": "8%",
        "zoom_avg_cpu_usage": "12%",
        "zoom_max_cpu_usage": "18%",
        "system_max_cpu_usage": "40%"
      },
      "cpu_pressure_level": {
        "system_min_cpu_pressure_level": "normal",
        "system_avg_cpu_pressure_level": "normal",
        "system_max_cpu_pressure_level": "normal"
      }
    }
  ]
}

Content-Type: application/json

Example:

{
  "page_size": 30,
  "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
  "stream_ingestions": [
    {
      "stream_id": "sfk/aOFJSJSYhGwk1hnxgw==",
      "stream_name": "stream ingestion1",
      "stream_description": "stream ingestion1",
      "stream_key": "ABCDEFG12345HIJ6789",
      "stream_url": "rtmp://a.rtmp.zoomevent.com/live1",
      "backup_stream_url": "rtmp://a.rtmp.zoomevent.com/live1"
    }
  ]
}

• stream_name (required)

  string — The stream ingestion name.

• stream_description

  string — The stream ingestion description.

Content-Type: application/json

Example:

{
  "stream_id": "sfk/aOFJSJSYhGwk1hnxgw==",
  "stream_name": "stream ingestion1",
  "stream_description": "stream ingestion1",
  "stream_key": "ABCDEFG12345HIJ6789",
  "stream_url": "rtmp://a.rtmp.zoomevent.com/live1",
  "backup_stream_url": "rtmp://a.rtmp.zoomevent.com/live1"
}

Content-Type: application/json

Example:

{
  "stream_id": "sfk/aOFJSJSYhGwk1hnxgw==",
  "stream_name": "stream ingestion1",
  "stream_description": "stream ingestion1",
  "stream_key": "ABCDEFG12345HIJ6789",
  "stream_url": "rtmp://a.rtmp.zoomevent.com/live1",
  "backup_stream_url": "rtmp://a.rtmp.zoomevent.com/live1"
}

• stream_description

  string — The stream ingestion description.

• stream_name

  string — The stream ingestion name.

Content-Type: application/json

Example:

{
  "from": "2021-12-01",
  "to": "2021-12-02",
  "cloud_recording_storage": [
    {
      "date": "2021-12-01",
      "usage": "29 MB",
      "plan_usage": "1 GB",
      "free_usage": "1 GB"
    }
  ]
}

Content-Type: application/json

Example:

{
  "year": 2021,
  "month": 12,
  "dates": [
    {
      "date": "2021-12-01",
      "sessions": 20,
      "users": 80,
      "session_minutes": 380
    }
  ]
}

Content-Type: application/json

Example:

{
  "page_size": 30,
  "next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2",
  "from": "2021-12-01",
  "to": "2021-12-02",
  "operation_logs": [
    {
      "time": "2019-08-20T19:09:01Z",
      "operator": "someuser@sfksfhksdfsf.com",
      "category_type": "User",
      "action": "update",
      "operation_detail": "Activate User sjkfhdsf@jdfgkhgd.com"
    }
  ]
}

Content-Type: application/json

Example:

{
  "page_size": 30,
  "next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2",
  "from": "2019-07-15",
  "to": "2019-07-20",
  "telephony_usage": [
    {
      "session_id": "sfk/aOFJSJSYhGwk1hnxgw==",
      "phone_number": "18005555555",
      "signaled_number": "18005555555",
      "start_time": "2019-07-15T23:24:52Z",
      "end_time": "2019-07-15T23:30:19Z",
      "duration": 6,
      "total": 11,
      "country_name": "Macau SAR",
      "call_in_number": "15555555555",
      "type": "toll-free",
      "rate": 12
    }
  ]
}

Content-Type: application/json