You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

批量禁言/拉黑会话成员 BatchAddBlockParticipants

最近更新时间：2024.01.29 15:25:31

首次发布时间：2023.05.25 18:20:26

我的收藏

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

使用说明

接口行为

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

目前仅直播群支持此接口

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

  • 请求方式：POST
  • 请求地址：https://rtc.volcengineapi.com?Action=BatchAddBlockParticipants&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是BatchAddBlockParticipants接口名称。当前 API 的名称为 BatchAddBlockParticipants。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
ConversationShortIdLong是000001会话 ID

BlockAction

Integer

否

0

操作行为

  • 0：禁言。用户无法在直播群中发言。
  • 1：拉黑。用户无法加入直播群。
    默认值为 0
ParticipantBlockInfosJSON Map是{"10001":6000}key 为群成员 ID，类型：String，只能传userId，value 为禁言或者拉黑时长，类型：int，单位为秒。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述
FailedParticipantUserIdsArray of Long[11]禁言或者拉黑失败的会话成员 UserId

请求示例

POST https://rtc.volcengineapi.com?Action=BatchAddBlockParticipants&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationShortId": 000001,
    "BlockAction": 0,
    "ParticipantBlockInfos": {
        "10001": 6000,
        "10002": 5000
    }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "BatchAddBlockParticipants",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-beijing"
  },
  "Result": {
    "FailedParticipantUserIds": [
      10001
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。