You need to enable JavaScript to run this app.
文档中心
文档备案控制台
实时音视频

实时音视频

请输入
  • 文档首页
    • 实时音视频即时通讯 IM（文档停止维护）服务端 API 参考服务端 OpenAPI用户注册注册用户 RegisterUsers
复制全文
下载 pdf
我的收藏
用户注册
注册用户 RegisterUsers
复制全文
下载 pdf
我的收藏
注册用户 RegisterUsers

你可以使用此接口注册用户或者机器人。
进行注册后，IM会存储用户资料，同时注册的用户uid列表会在全员广播的时候使用。
当前注册广播用户仅用来进行全员广播，其他操作如发消息无需注册用户。

使用说明

接口行为

你可以调用 RegisterUsers 接口，指定你所属的 AppId、用户 ID ， 用户 Tag 进行注册。

调用接口

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

注意事项

  • QPS 不得超过 50。
  • 机器人数量不得超过 5000。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
UsersArray of Users是-注册用户的信息。一次最多注册 20 个用户。

Users

参数类型是否必选示例值描述
UserIdLong是10001注册用户的 UserId
NickNameString否"Your_NickName"注册用户昵称。长度不能超过 100 字符。
TagsArray of String否["age","old"]用户标签。用于全员广播
PortraitString否"http://xxxxx"头像url。长度不能超过500字符
ExtJSON Map否"key":"value"扩展字段。key 的类型为 String，value 的类型为 String。
IsRobotBoolean否false用户是否为机器人，默认为 false

返回参数

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

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

FailedInfos

参数类型示例值描述
UserIdStringYour_UserId失败用户的 UserId
CodeStringUserNotFound错误码。参错误码
MessageString-错误详细信息

请求示例 

POST https://rtc.volcengineapi.com?Action=RegisterUsers&Version=2020-12-01
{
    "AppId": 000000,
    "Users": [
        {
            "UserId": 10004,
            "NickName": "Your_NickName",
            "Portrait": "http://xxxxx",
            "Tags": [
                "标签值"
            ],
            "Ext": {
                "key":"value"
            },
            "IsRobot": false
        }
    ]
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "Your_****estId",
        "Action": "RegisterUsers",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedInfos": [
            {
                "UserId": "10004",
                "Message": "UserisNotFound",
                "Code": "UserNotFound"
            }
        ]
    }
}

错误码

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

最近更新时间：2025.08.14 17:45:01
这个页面对您有帮助吗？
有用
有用
无用
无用