开启录制

POST

/rsc/api/v3/user/sessions/{sessionId}/records/actions/start

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

sessionId

string

会话 id

必需

示例值:

Header 参数

x-endpoint-id

string

操作人端点Id

必需

示例值:

Body 参数application/json

layoutTemplate

string | null

必需

录制布局模版，由后端直接透传给媒体
一方主讲人：SINGLE_ACTIVEVIDEO
双方主讲人：TWO_ACTIVEVIDEO
三方主讲人：THREE_ACTIVEVIDEO
四方主讲人：FOUR_ACTIVEVIDEO
九宫格：GRIDDING_VIDEO_3X3
十六宫格：GRIDDING_VIDEO_4X4
二十五宫格：GRIDDING_VIDEO_5X5

layoutMode

integer | null

必需

录制布局模式 1自定义布局优先，0 采用录制模板

示例

{
    "layoutTemplate": "SINGLE_ACTIVEVIDEO",
    "layoutMode": 1
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/rsc/api/v3/user/sessions/{{sessionId}}/records/actions/start' \
--header 'x-endpoint-id: {{endpointId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "layoutTemplate": "SINGLE_ACTIVEVIDEO",
    "layoutMode": 1
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

根据会议号查询端点和会话信息

停止录制