会中控制

结束会议

POST /server/v1/meet-admin/destroy 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

请求示例：

{
  "meeting_id": "",
  "room_no": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

更新房间视频状态

POST /server/v1/meet-admin/update-room-camera-state 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

boolean

全体关视频时，是否禁止成员自行打开 false:不禁止(默认) true：禁止。camera_disabled 传 false 时会一并重置为 false

boolean

全体关视频 false:不关(默认) true：关

请求示例：

{
  "camera_disabled": false,
  "meeting_id": "",
  "room_no": "",
  "self_unmute_camera_disabled": false
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

更新房间音频状态

POST /server/v1/meet-admin/update-room-mic-state 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

boolean

全体静音时，是否禁止成员自行解除 false:不禁止(默认) true：禁止。mic_disabled 传 false 时会一并重置为 false

boolean

全体静音 false:不静音(默认) true：静音

请求示例：

{
  "meeting_id": "",
  "mic_disabled": false,
  "room_no": "",
  "self_unmute_mic_disabled": false
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新房间共享状态

POST /server/v1/meet-admin/update-room-share-disabled 鉴权：需要（见概览）更新房间共享状态 请求参数

string

房间号

string

会议ID

禁止共享 false:不禁止(默认) true：禁止

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "share_disabled": false
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新房间聊天禁用状态

POST /server/v1/meet-admin/update-room-chat-disabled 鉴权：需要（见概览）更新房间聊天禁用状态 请求参数

string

房间号

string

会议ID

boolean

必填

禁止全体聊天 false:不禁止 true：禁止

请求示例：

{
  "chat_disabled": false,
  "meeting_id": "",
  "room_no": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新房间截屏开关状态

POST /server/v1/meet-admin/update-room-screenshot-disabled 鉴权：需要（见概览）更新房间截屏开关状态 请求参数

string

房间号

string

会议ID

boolean

必填

禁止截屏 false:不禁止 true：禁止

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "screenshot_disabled": false
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新房间水印开关状态

POST /server/v1/meet-admin/update-watermark-disabled 鉴权：需要（见概览）更新房间水印开关状态 请求参数

string

房间号

string

会议ID

boolean

必填

关闭水印 false:开启水印 true：关闭水印

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "watermark_disabled": false
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新房间锁定状态

POST /server/v1/meet-admin/update-locked 鉴权：需要（见概览）更新房间锁定状态 请求参数

string

房间号

string

会议ID

boolean

必填

锁定会议，锁定后新人无法进入 false:不锁定 true：锁定

请求示例：

{
  "locked": false,
  "meeting_id": "",
  "room_no": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人结束共享

POST /server/v1/meet-admin/stop-room-share 鉴权：需要（见概览）结束共享 请求参数

string

房间号

string

会议ID

请求示例：

{
  "meeting_id": "",
  "room_no": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新用户会中角色

POST /server/v1/meet-admin/update-user-role 鉴权：需要（见概览）更新用户角色 请求参数

string

房间号

string

会议ID

string

必填

用户id

integer

必填

用户角色

请求示例：

{
  "meeting_id": "",
  "role": 0,
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新用户会中昵称

POST /server/v1/meet-admin/update-user-name 鉴权：需要（见概览）更新用户会中呢称 请求参数

string

房间号

string

会议ID

string

必填

用户id

string

必填

改成的会中昵称

请求示例：

{
  "meeting_id": "",
  "nickname": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人更新用户聊天禁用状态

POST /server/v1/meet-admin/update-user-chat-disabled 鉴权：需要（见概览）更新用户聊天禁用状态 请求参数

string

房间号

string

会议ID

string

必填

用户id

boolean

必填

禁止该用户聊天 false:不禁止 true：禁止

请求示例：

{
  "chat_disabled": false,
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人关闭用户摄像头

POST /server/v1/meet-admin/close-user-camera 鉴权：需要（见概览）关闭用户摄像头 请求参数

string

房间号

string

会议ID

string

必填

用户id

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人关闭用户麦克风

POST /server/v1/meet-admin/close-user-mic 鉴权：需要（见概览）关闭用户麦克风 请求参数

string

房间号

string

会议ID

string

必填

用户id

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人请求用户共享

POST /server/v1/meet-admin/request-user-share 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

string

必填

用户id

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人请求用户开视频

POST /server/v1/meet-admin/request-user-open-camera 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

string

必填

用户id

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人请求用户开音频

POST /server/v1/meet-admin/request-user-open-mic 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

string

必填

用户id

请求示例：

{
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人踢人

POST /server/v1/meet-admin/kickout-user 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

string

必填

用户id

boolean

是否从白名单中移除

boolean

是否黑名单

请求示例：

{
  "join_disabled": false,
  "meeting_id": "",
  "remove_conferee": false,
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

主持人处理举手申请

POST /server/v1/meet-admin/confirm-handup 鉴权：需要（见概览）处理举手申请 请求参数

string

房间号

string

会议ID

string

必填

用户id

integer

必填

申请类型 1开音频 2开视频 3聊天 4共享 5绘画(涂鸦)

boolean

必填

true 允许 false 不允许

请求示例：

{
  "approve": false,
  "code": 0,
  "meeting_id": "",
  "room_no": "",
  "target_id": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

会议时呼叫人员入会

POST /server/v1/meet-admin/call-users 鉴权：需要（见概览） 请求参数

string

房间号

string

会议ID

array<string>

参会人员（兼容旧接口）

array<object>

参会人员详情列表（新接口）

显示元素字段

string

用户ID

string

用户帐号

string

真实名称

string

会中昵称，不填则用 real_name

string

用户头像

integer

用户角色

boolean

是否是追加

boolean

是否强制加入(调呼叫入会时参数才有效)

请求示例：

{
  "conferee": [
    ""
  ],
  "conferee_details": [
    {
      "account": "",
      "avatar": "",
      "nickname": "",
      "real_name": "",
      "role": 0,
      "user_id": ""
    }
  ],
  "force_join": false,
  "is_additional": false,
  "meeting_id": "",
  "room_no": ""
}

响应参数

string

返回数据

响应示例：

{
  "code": 0,
  "data": ""
}

概览

带 UI 极简对接

iOS SDK

Android SDK

Windows SDK

Web SDK

微信小程序 SDK

服务端 API

结束会议

更新房间视频状态

更新房间音频状态

主持人更新房间共享状态

主持人更新房间聊天禁用状态

主持人更新房间截屏开关状态

主持人更新房间水印开关状态

主持人更新房间锁定状态

主持人结束共享

主持人更新用户会中角色

主持人更新用户会中昵称

主持人更新用户聊天禁用状态

主持人关闭用户摄像头

主持人关闭用户麦克风

主持人请求用户共享

主持人请求用户开视频

主持人请求用户开音频

主持人踢人

主持人处理举手申请

会议时呼叫人员入会

​结束会议

​更新房间视频状态

​更新房间音频状态

​主持人更新房间共享状态

​主持人更新房间聊天禁用状态

​主持人更新房间截屏开关状态

​主持人更新房间水印开关状态

​主持人更新房间锁定状态

​主持人结束共享

​主持人更新用户会中角色

​主持人更新用户会中昵称

​主持人更新用户聊天禁用状态

​主持人关闭用户摄像头

​主持人关闭用户麦克风

​主持人请求用户共享

​主持人请求用户开视频

​主持人请求用户开音频

​主持人踢人

​主持人处理举手申请

​会议时呼叫人员入会

结束会议

更新房间视频状态

更新房间音频状态

主持人更新房间共享状态

主持人更新房间聊天禁用状态

主持人更新房间截屏开关状态

主持人更新房间水印开关状态

主持人更新房间锁定状态

主持人结束共享

主持人更新用户会中角色

主持人更新用户会中昵称

主持人更新用户聊天禁用状态

主持人关闭用户摄像头

主持人关闭用户麦克风

主持人请求用户共享

主持人请求用户开视频

主持人请求用户开音频

主持人踢人

主持人处理举手申请

会议时呼叫人员入会