增加巡检者
更新时间: 2024/08/15 17:35:44
通过该接口为某个房间的巡检者角色绑定用户。
功能描述
如何有效地检查和管理会议中可能会存在的违规内容或其他违规行为一直是一个令会议服务提供商头疼的问题。会议组件提供巡检者模式,开发者可自行搭建巡检页面,通过巡检者的身份加入到会议中进行人工巡查,检查会议中是否存在违规内容或其他违规行为。如果发现了违规内容,开发者可以通过结束会议接口结束会议,从而保障整体会议服务的安全。
接口请求信息
- 请求方法:PUT
- URL:https://roomkit.netease.im/apps/v2/room/bind/observer
前提条件
已为巡检者角色的用户创建会议账号。
注意事项
- 1 个房间可以添加 10 个巡检者用户。如果要添加多个巡检者用户,请重复调用本接口。
- 1 个用户可以绑定多个房间。
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
请求中 Body 须为 JSON 格式,参数说明如下:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
roomArchiveId | Long | 必选 | 1234567 | 请填写待添加巡检者的目标房间的 roomArchiveId,您可以通过创建会议的返回参数中获取该参数的值。 |
userUuid | String | 必选 | abc | 待绑定的巡检者对应的用户 ID。一次只能填写一个用户 ID 。您可以通过创建会议账号的返回参数中获取该参数的值。 |
返回参数
以下是返回结果中 data
属性内包含的参数。其他统一返回参数的相关说明请参考返回结果。
参数名称 | 类型 | 描述 |
---|---|---|
code | Integer | 状态码。0 表示成功。非 0 表示失败。 |
msg | String | 状态描述。 |
ts | Long | 当前时间戳,单位为毫秒。 |
cost | String | 该请求耗费的时间。 |
requestId | String | 请求 ID。 |
示例
请求 Body 示例
json{
"roomArchiveId": 1234567,
"userUuid": "abc"
}
返回示例
{
"code": 0,
"msg": "Success",
"ts": 1619068087795,
"requestId": "6e507107d1f441234731abcdec6d2432",
"cost": "66ms"
}
此文档是否对你有帮助?