你可以使用此接口批量移除全员禁言下白名单成员。
你可以调用BatchRemoveWhitelistParticipant接口,指定你所属的AppId、会话 ID、 操作人 UserId、要移除白名单成员 UserId,批量移除全员禁言下可发言白名单成员。
目前仅直播群支持此接口
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
QPS 不得超过 50。
使用 POST 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | BatchRemoveWhitelistParticipant | 接口名称,本接口取值:BatchRemoveWhitelistParticipant |
| Version | String | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | Int | 是 | 000000 | 应用的唯一标志 |
| ConversationShortId | Int | 是 | 000001 | 会话 ID |
| Operator | Int | 是 | 000010 | 操作人 UserId |
| ParticipantUserIds | Array of Int | 是 | [10001,10002] | 要移除白名单用户 UserId |
https://rtc.volcengineapi.com?Action=BatchRemoveWhitelistParticipant&Version=2020-12-01
Postscript{
"AppId":000000,
"ConversationShortId":000001,
"Operator":000010,
"ParticipantUserIds":[10001,10002]
}
Json返回结果参看 BaseResponse。
其中 Result 的结构如下:
| 参数名 | 类型 | 描述 |
|---|---|---|
| FailedManagerUserIds | Array of Int | 移除失败的 UserId |
{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "BatchRemoveWhitelistParticipant",
"Version": "2020-12-01",
"Serzvice": "rtc",
"Region": "cn-north-1"
},
"Result": {
"FailedManagerUserIds": []
}
}
Json