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

批量添加群聊成员 BatchAddConversationParticipant

最近更新时间：2023.11.29 20:00:20

首次发布时间：2023.04.24 11:11:46

我的收藏

你可以使用此接口向群聊中批量添加群成员。

接口行为

你可以调用BatchAddConversationParticipant接口，指定你所属的AppId、会话 ID，群成员信息和操作人 UserId 为指定群批量添加群成员。

你无法为单聊添加会话成员。

群聊添加成员上限与你在控制台的设置一致。

若待添加成员已在群聊中，调用此接口会覆盖原有数据，但并不推荐使用该接口进行成员信息更新。

服务端并不会对添加群成员的执行者做预先校验，如判断其是否在群中、是否有权限等。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionString是BatchAddConversationParticipant接口名称，本接口取值：BatchAddConversationParticipant
VersionString是2020-12-01接口版本，本接口取值：2020-12-01

Body

参数名类型必填示例值描述
AppIdInt是000000应用的唯一标志
ConversationShortIdInt是000001会话 ID
ParticipantInfosArray of ParticipantInfo是/群成员信息
OperatorInt是000010执行加群操作人的 UserId
BarrierBool否false是否开启屏障。如设置屏障，新加入用户无法看到历史会话消息。
  • false：不开启。
  • true：开启。
默认值为false。

ParticipantInfo

参数名类型必填示例值描述
ParticipantUserIdInt是10001添加成员所属 UserId，UserId 必须大于 0。
LevelInt否1成员等级
NickNameString否Your_NickName成员昵称
RoleInt否0成员身份，枚举值为 {0，1，2}。
  • 0：普通成员。
  • 1: 群主。添加群主时，需确保会话中的 ownerUid 与群主的 UserId 相同。
  • 2：群管理员。
默认值为0，值不合法时自动调整为默认值。
Extmap-key(string)-value(string)否"key":"value"成员扩展字段
ReadIndexInt否0成员已读位置点

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "Operator":10001,
    "ParticipantInfos":[
        {
            "ParticipantUserId":10001,
            "Level":1,
            "NickName":"Your_NickName",
            "Role":1,
            "Ext":{
                "key":"value"
            },
            "ReadIndex":0
        },
        {
            "ParticipantUserId":10002,
            "Level":20,
            "NickName":"NickName2",
            "Role":0,
            "Ext":{
                "key":"value"
            },
            "ReadIndex":0
        }
    ]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名类型描述
FailedUserIdsArray of Int成功时为空，失败时返回失败用户 ID

正常返回示例

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