更新用户标签 BatchUpdateUserTags--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

更新用户标签 BatchUpdateUserTags

最近更新时间：2024.02.20 12:02:51首次发布时间：2023.08.15 19:07:15

你可以使用此接口已注册的广播用户进行标签更新。

使用说明

你可以调用 BatchUpdateUserTags 接口，指定你所属的 AppId、用户 ID、用户 Tag 对已注册的广播用户进行标签更新。

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`Your_AppId`	应用的唯一标志
UserIds	Array of Long	是	`[10001,10002]`	用户userId列表
Tags	Array of String	是	`["age","level"]`	用户标签
Op	Integer	是	`1`	标签更新方式。 0：追加参数指定的标签，如果要追加的标签已存在则直接忽略 1：删除参数指定的标签，如果要删除的标签不存在则直接忽略默认值为 0。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
FailedInfos	Array of FailedInfos	`-`	更新失败的用户信息

FailedInfos

参数	类型	示例值	描述
UserId	Long	`Your_UserId`	用户 UserId
Code	String	`-`	错误码。参考:错误码
Message	String	`-`	错误信息。

请求示例

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

{
    "AppId": 000000,
    "UserIds": [1000001,1000002],
    "Tags": ["tag1:v1", "tag2:v2"],
    "Op": 1
}

返回示例

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

错误码

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