批量添加全员禁言下白名单成员 BatchAddWhitelistParticipant--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量添加全员禁言下白名单成员 BatchAddWhitelistParticipant

最近更新时间：2024.01.29 12:02:32首次发布时间：2023.06.21 18:41:10

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

使用说明

接口行为

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

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`BatchAddWhitelistParticipant`	接口名称。当前 API 的名称为 `BatchAddWhitelistParticipant`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
Operator	Long	是	`000010`	操作人 UserId
ParticipantUserIds	Array of Long	是	`[10001,10002]`	要添加白名单成员 UserId

返回参数

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

参数	类型	示例值	描述
FailedUserIds	Array of Long	`[997]`	添加失败的 UserId

请求示例

POST https://rtc.volcengineapi.com?Action=BatchAddWhitelistParticipant&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationShortId": 000001,
    "Operator": 000010,
    "ParticipantUserIds": [
        10001,
        10002
    ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "BatchAddWhitelistParticipant",
    "Version": "2020-12-01",
    "Service": "***",
    "Region": "cn-beijing"
  },
  "Result": {
    "FailedUserIds": [
      997
    ]
  }
}

错误码

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