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

更新用户资料 BatchUpdateUser

最近更新时间：2024.02.20 15:21:53

首次发布时间：2023.12.28 20:05:16

我的收藏

你可以调用此接口对用户资料进行更新。

使用说明

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

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是BatchUpdateUser接口名称。当前 API 的名称为 BatchUpdateUser。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。

Body

参数类型是否必选示例值描述
AppIdInteger是000001用户的唯一标识
UsersArray of Users是-用户资料。一次最多 10 个用户

Users

参数类型是否必选示例值描述
UserIdLong是10001用户id
NickNameString否Your_NickName昵称
PortraitString否http://xxxx.xxxx头像 url
TagsArray of String否["age","value"]标签
ExtJSON Map否"key":"value"扩展字段。key 的类型为 string，value 的类型为 string。

返回参数

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

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

FailedInfos

参数类型示例值描述
UserIdLong更新失败的用户 UserId
CodeString-错误码。参考错误码
MessageString-错误信息。

请求示例

POST https://rtc.volcengineapi.com?Action=BatchUpdateUser&Version=2020-12-01
{
    "AppId": 11,
    "Users": [
        {
            "Tags": [
                "age","level"
            ],
            "Portrait": "http://xxxx.xxxx",
            "NickName": "Your_NickName",
            "UserId": 10001,
            "Ext":{
                "key":"value"
            }
        }
    ]
}

返回示例

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

错误码

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