更新直播群成员资料 BatchUpdateLiveParticipants--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

更新直播群成员资料 BatchUpdateLiveParticipants

最近更新时间：2023.12.28 20:05:15首次发布时间：2023.10.30 19:49:38

你可以使用此接口更新直播群成员资料。

使用说明

接口行为

你可以调用 BatchUpdateLiveParticipants 接口，指定你所属的AppId、会话 Id、直播群成员 ID 来更新群成员资料。

目前仅直播群支持此接口

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
ParticipantInfos	Array of ParticipantInfo	是	`-`	需要更新的成员资料。一次最多支持 10 个成员。
MarkAction	Integer	否	`1`	更新群成员标记。默认值为 `1`。 `1`：添加 `2`：删除

ParticipantInfo

参数	类型	是否必选	示例值	描述
UserId	Long	是	`10001`	群成员用户 ID
AvatarUrl	String	否	`Your_AvatarUrl`	群成员头像。`AvatarUrl`、`NickName`和`Ext`均为非必填参数，但是至少需要填一个，否则服务端会报错。
NickName	String	否	`Your_NickName`	群成员昵称
Ext	JSON Map	否	`"key":"value"`	群成员扩展字段。`key` 的类型为 `String`，`value` 的类型为 `String`。
Marks	Array of String	否	`["Mark1","Mark2"]`	群成员标记

返回参数

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

参数	类型	示例值	描述
FailedInfos	Array of FailedInfos	`-`	更新资料失败的群成员信息

FailedInfos

参数	类型	示例值	描述
UserId	Long	`99999`	更新资料失败的群成员的 UserId
Code	String	`ParticipantNotInConversation`	错误码
Message	String	`participant not in conversation`	错误描述

请求示例

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

{
    "AppId":000000,
    "ConversationShortId":000001,
    "ParticipantInfos":[
    {
        "UserId":10002,
        "AvatarUrl":"https://xxxx.com",
        "NickName":"Nickname1",
        "Ext":{
            "key":"value"
        }
        "Marks": ["Mark1","Mark2"]
    },
    {
        "UserId":10001,
        "AvatarUrl":"https://yyyy.com",
        "NickName":"Nickname2",
        "Ext":{
            "key":"value"
        }
        "Marks": ["Mark1","Mark2"]
    },
    {
        "UserId":99999,
        "AvatarUrl":"https://xxxx.com",
        "NickName":"Nickname3",
        "Ext":{
            "key":"value"
        }
        "Marks": ["Mark1","Mark2"]
    }
   ],
   "MarkAction":1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023092620261328037E0DB0EC6C03DD41",
        "Action": "BatchUpdateLiveParticipants",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedInfos": [
            {
                "UserId": 99999,
                "Code": "ParticipantNotInConversation",
                "Message": "participant not in conversation"
            }
        ]
    }
}

错误码

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