批量添加直播群管理员 BatchAddManager--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量添加直播群管理员 BatchAddManager

最近更新时间：2023.11.27 20:36:34首次发布时间：2023.06.21 18:41:09

你可以使用此接口向直播群中批量添加管理员。

接口行为

你可以调用BatchAddManager接口，指定你所属的AppId、会话 ID、操作人 UserId 和要添加管理员的成员 UserId 批量添加管理员。

目前仅直播群支持此接口

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ConversationShortId	Int	是	`000001`	会话 ID
Operator	Int	是	`100001`	操作人 UserId
ManagerUserIds	Array of Int	是	`[10002,10004]`	要添加为管理员的群成员 UserId

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "Operator":100001,
    "ManagerUserIds":[10002,10004]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
FailedManagerUserIds	Array of Int	添加失败的 UserId

正常返回示例

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