批量取消禁言/取消拉黑会话成员 BatchDeleteBlockParticipants--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量取消禁言/取消拉黑会话成员 BatchDeleteBlockParticipants

最近更新时间：2023.10.19 19:28:46首次发布时间：2023.05.25 18:20:26

你可以使用此接口在直播群中批量取消禁言或取消拉黑会话成员。

接口行为

你可以调用BatchDeleteBlockParticipants接口，指定你所属的AppId、会话 ID、会话成员 UserId 列表和具体的操作行为，来批量取消禁言和取消拉黑会话成员。

目前仅直播群支持此接口

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`BatchDeleteBlockParticipants`	接口名称，本接口取值：`BatchDeleteBlockParticipants`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ConversationShortId	Int	是	`000001`	会话 ID
BlockAction	Int	否	`0`	操作行为。 `0`：取消禁言。 `1`：取消拉黑。默认值为 `0`。
ParticipantUserIds	Array of Int	是	`[10001,10002]`	取消禁言或者取消拉黑的会员成员 UserId 列表

请求示例代码

Query

https://rtc.volcengineapi.com?Action=BatchDeleteBlockParticipants&Version=2020-12-01

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "BlockAction":0,
    "ParticipantUserIds":[10001]
}

返回调用结果

返回参数说明

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

参数名	类型	描述
FailedParticipantUserIds	Array of Int	取消禁言或者取消拉黑失败的会话成员 UserId

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BatchDeleteBlockParticipants",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedParticipantUserIds": []
    }
}