使用会议中控件 - Zoom API 中文版

Control in-meeting 功能。会议中控制包括开始和停止录制、暂停和恢复录制以及邀请参与者。

** 注意: ** 此API的录制控件仅适用于云录制。它 ** 不适用于本地录音。

** 先决条件: **

会议 ** 必须 ** 是现场会议 **，但 ** 通过 [呼叫 (电话)/(会议室系统)] 邀请与会者参加会议除外。

记录控制: 必须在帐户上启用云记录。

调用此API的用户必须是主持人或备用会议主持人。

** 范围: ** 'meeting:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'Medium'

请求参数

Path 参数

meetingId

string

必需

live meeting的ID。

accountId

string

帐户的唯一标识符。

必需

Body 参数application/json

method

string

可选

要控制的会议方法:

'Reording.start'-开始录制。

'Reording.stop'-停止录制。

'Reording.pause'-暂停录制。

'Reording.resume'-恢复暂停的录制。

'participant.invite'-邀请参与者参加会议。

参与者。'invite.ca'-通过 [呼叫 (电话)] 邀请参与者参加会议 (https://support.zoom.us/hc/en-us/articles/4404535651085-通过电话邀请他人)。

'participant.invite.Room_ system_callout '-通过 [callout (房间系统)] 邀请参与者参加会议。

示例值:

recording.start

params

object

会议中的参数。

可选

device_ip

string

可选

用户的设备IP地址或URI。如果为 “方法” 字段传递 “participant.invite.Room_ system_callout” 值，请使用此字段。

示例值:

10.100.111.237

sip_headers

object

可选

使客户能够利用需要自定义 “从” 标头的服务来识别调用方。如果为 “method” 字段传递 “participant.invite.Room_ system_callout” 值，并为 “call_type” 字段传递 “sip'” 值，则使用此字段。

invite_options

object

可选

有关 “participant.invite.ca llout' 设置的信息。

phone_number

string

可选

用户的电话号码。如果为 “方法” 字段传递 “参与者.invite.ca llout' 值，请使用此字段。作为最佳实践，请确保其中包括国家代码和区号。

示例值:

5550100

invitee_name

string

可选

要在会议中显示的用户名。如果为 “方法” 字段传递 “参与者.invite.ca llout' 值，请使用此字段。

示例值:

Jill Chill

call_type

string

可选

呼叫的类型。请使用 “h323” 或 “sip' 的值。如果为 “方法” 字段传递 “participant.invite.Room_ system_callout” 值，请使用此字段。

示例值:

h323

contacts

array [object {2}]

可选

用户的电子邮件地址或用户ID，最多10个联系人。该帐户必须是会议主持人帐户的一部分。

h323_headers

object

可选

使客户能够利用需要自定义 “从” 标头的服务来识别调用方。如果为 “method” 字段传递 “participant.invite.Room_ system_callout” 值，并为 “call_type” 字段传递 “h323” 值，请使用此字段。

示例

{
    "method": "recording.start",
    "params": {
        "device_ip": "10.100.111.237",
        "sip_headers": {
            "from_uri": "sip:username@domain.company.org",
            "additional_headers": [
                {
                    "value": "X-body1",
                    "key": "X-Header1"
                }
            ],
            "from_display_name": "display name",
            "to_display_name": "display name"
        },
        "invite_options": {
            "require_pressing_one": true,
            "require_greeting": true
        },
        "phone_number": "5550100",
        "invitee_name": "Jill Chill",
        "call_type": "h323",
        "contacts": [
            {
                "id": "30R7kT7bTIKSNUFEuH_Qlg",
                "email": "jchill@example.com"
            }
        ],
        "h323_headers": {
            "from_display_name": "display name",
            "to_display_name": "display name"
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢202** HTTP状态: ** '202' ** 已接受 ** 请求已成功处理。

application/json

Body

object {0}

示例

{}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '300' * 会议id不存在。 * 无效的会议id。 * 会议不存在。 * 没有权限。 * 此API不适用于此帐户，请联系Zoom支持。 ** 错误代码: ** '3309 ' 云存储空间不足。购买额外的存储空间或删除云录制以释放存储空间。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '3001' 会议 {meetingId} 未找到或已过期。

🟠429** HTTP状态代码: ** '429' 未定义