你可以使用此接口批量移除全员禁言下白名单成员。

接口行为

你可以调用BatchRemoveWhitelistParticipant接口,指定你所属的AppId、会话 ID、 操作人 UserId、要移除白名单成员 UserId,批量移除全员禁言下可发言白名单成员。
目前仅直播群支持此接口

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是BatchRemoveWhitelistParticipant接口名称,本接口取值:BatchRemoveWhitelistParticipant
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdInt是000000应用的唯一标志
ConversationShortIdInt是000001会话 ID
OperatorInt是000010操作人 UserId
ParticipantUserIdsArray of Int是[10001,10002]要移除白名单用户 UserId
请求示例代码
Query
https://rtc.volcengineapi.com?Action=BatchRemoveWhitelistParticipant&Version=2020-12-01
Postscript
Body
{
    "AppId":000000,
    "ConversationShortId":000001,
    "Operator":000010,
    "ParticipantUserIds":[10001,10002]
}
Json
返回调用结果
返回参数说明

返回结果参看 BaseResponse。
其中 Result 的结构如下:

参数名类型描述
FailedManagerUserIdsArray of Int移除失败的 UserId
正常返回示例
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BatchRemoveWhitelistParticipant",
        "Version": "2020-12-01",
        "Serzvice": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedManagerUserIds": []
    }
}
Json