设置频道禁言
设置频道禁言
API 地址
api.vhallyun.com/api/v2/channel/set-channel
描述
根据频道ID和第三方用户ID,禁言频道或者频道内的某个人
场景描述
例如在直播过程中,存在疯狂刷屏的用户,严重干扰了直播间秩序,即可利用频道禁言的功能,使该用户无法发言
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 | 类型 | 是否必选 | 含义 |
|---|---|---|---|
| channel_id | string | 是 | 频道ID |
| third_party_user_id | string | 是 | 第三用户ID |
| target_id | string | 否 | 被禁言者ID,当type为disable和permit时此值必填 |
| type | string | 是 | disable 禁言频道内某个用户的聊天(频道内单个用户的禁言)、disable_all 禁言整个频道的聊天(全员禁言)、permit 取消禁言频道内某个用户的聊天(取消频道内单个用户的禁言)、 permit_all 取消禁言整个频道的聊天 (取消全员禁言) |
出参
| 参数 | 类型 | 是否必选 | 含义 |
|---|
错误码
| 错误码 | 类型 | 含义 |
|---|---|---|
| 10006 | int | 第三方用户ID不能为空 |
| 10016 | int | 频道ID不能为空 |
| 10062 | int | 频道设置类型不能为空 |
| 10063 | int | 频道被操作者ID不能为空 |
| 20004 | int | 频道查询为空 |
| 30002 | int | 不是当前频道拥有者 |
| 40006 | int | 频道类型不正确 |
| 40051 | int | 设置被禁言人ID错误 |
| 40052 | int | 设置频道禁言状态不正确 |
| 40054 | int | 禁言/取消禁言单个用户时target_id不能为空 |
| 50013 | int | 检查聊天频道第三方用户在线状态失败 |
| 50027 | int | 设置频道禁言失败 |
响应格式
{
"code": 200,
"msg": null,
"data":[]
}
