You need to enable JavaScript to run this app.
导航

批量修改群聊成员详情 BatchModifyConversationParticipant

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

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

你可以使用此接口批量对群成员的详细信息进行修改。

接口行为

你可以调用BatchModifyConversationParticipant接口,指定你所属的AppId、会话 ID,待修改群成员信息和操作人 UserId 批量修改群成员的详细信息。

如果用户已经退群,无法对其进行修改。

单聊无法调用此接口。
服务端并不会对添加群成员的执行者做预先校验,如判断其是否在群中、是否有权限等。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringBatchModifyConversationParticipant接口名称,本接口取值:BatchModifyConversationParticipant
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
OperatorInt000010执行修改群成员信息操作人的 UserId
ParticipantInfosArray of ParticipantInfo/群成员信息

ParticipantInfo

参数名类型必填示例值描述
ParticipantUserIdInt10001进行修改的群成员的 UserId,UserId 必须大于 0
LevelInt1成员等级
NickNameStringYour_NickName成员昵称
RoleInt0成员身份,枚举值为 {0,1,2}
  • 0:普通成员。
  • 1: 群主。
  • 2:群管理员。
默认值为0,值不合法时自动调整为默认值。
Extmap-key(string)-value(string)"key":"value"成员扩展字段
BlockTimeInt0禁言时间戳,表示禁言到何时,单位为秒。0表示未禁言。

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "Operator":10001,
    "ParticipantInfos":[
        {
            "ParticipantUserId":10001,
            "Ext":{
                "key":"value"
            }
        } 
    ]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

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

正常返回示例

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