查询会话选项

GET

/rsc/api/v1/user/sessions/{sessionId}/options

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

sessionId

string

必需

Header 参数

x-endpoint-id

string

操作人端点Id

必需

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

会话选项响应体

locked

boolean | null

是否锁定会议

必需

unmuteSelfEnabled

boolean | null

必需

是否能自行申请解除静音

allowSelfChangeNickname

boolean | null

必需

是否允许参会端点自行改名

muted

boolean | null

必需

是否是静音模式
「已废弃」

whiteBoardOption

enum<integer> | enum<null>

必需

白板设置，0全体可开启，1仅主持人可开启白板

枚举值:

shareOption

enum<integer> | enum<null>

共享设置

必需

枚举值:

markOption

enum<integer> | enum<null>

批注设置

必需

枚举值:

turnOnVideoSelfEnabled

boolean | null

必需

是否允许参会人自行打开摄像头：true允许，false禁止

autoMuteType

enum<integer> | enum<null>

必需

参会人入会自动静音类型，0不静音，1静音，2超过一定人数自动静音

枚举值:

012

endpointStatusUpdateNoticeType

enum<integer> | enum<null>

必需

端点状态更新提示类型，0不提示，1只对主持人提示，2对所有人提示

枚举值:

012

voiceActivationEnabled

boolean | null

必需

语音激励是否启用，0 未启用，1 启用

示例

{
  "locked": false,
  "unmuteSelfEnabled": false,
  "allowSelfChangeNickname": false,
  "muted": false,
  "whiteBoardOption": 0,
  "shareOption": 0,
  "markOption": 0,
  "turnOnVideoSelfEnabled": false,
  "autoMuteType": 0,
  "endpointStatusUpdateNoticeType": 0,
  "voiceActivationEnabled": false
}

配置会话选项

设置主会场轮询