全部产品
Search
文档中心

视频直播:BanLiveMessageGroup - 群组全员禁言

更新时间:Dec 05, 2024

调用BanLiveMessageGroup新增禁言用户。

接口说明

调用本接口前,您必须已经调用 CreateLiveMessageGroup 创建互动消息群组。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

demo
GroupIdstring

群组 ID。

grouptest
ExceptUsersarray

当开启全员禁言时不被禁言的用户。

string

当开启全员禁言时不被禁言的用户,多个用半角逗号(,)隔开。

说明 最多不超过 30 个。
["uid3"]
DataCenterstring

数据中心,需要与 CreateLiveMessageApp 中的数据中心一致。

说明 当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。
cn-shanghai

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

84AF36BF-0B39-1F8A-A416-FAC7C484****

示例

正常返回示例

JSON格式

{
  "RequestId": "84AF36BF-0B39-1F8A-A416-FAC7C484****"
}

错误码

HTTP status code错误码错误信息描述
400InputInvalid%s.输入参数不合法
403NoAuth%s.没有权限
404ResourceNotExist%s.请求资源不存在,请检查后重新尝试
500ServerError%s.未知错误,请稍后重试或提交工单咨询。

访问错误中心查看更多错误码。