最近更新时间：2024.01.29 15:25:32
首次发布时间：2023.08.15 19:07:14
你可以使用此接口注册用户。
进行注册后，IM会存储用户资料，同时注册的用户uid列表会在全院广播的时候使用。
当前注册广播用户仅用来进行全员广播，其他操作如发消息无需注册用户。
你可以调用 RegisterUsers 接口，指定你所属的 AppId、用户 ID ， 用户 Tag 进行注册。
关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。
QPS 不得超过 50。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | RegisterUsers | 接口名称。当前 API 的名称为 RegisterUsers。 |
| Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | Integer | 是 | 000000 | 应用的唯一标志 |
| Users | Array of Users | 是 | - | 注册用户的信息。一次最多注册 20 个用户。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| UserId | Long | 是 | 10001 | 注册用户的 UserId |
| NickName | String | 否 | "Your_NickName" | 注册用户昵称。长度不能超过 100 字符。 |
| Tags | Array of String | 否 | ["age","old"] | 用户标签。用于全员广播 |
| Portrait | String | 否 | "http://xxxxx" | 头像url。长度不能超过500字符 |
| Ext | JSON Map | 否 | "key":"value" | 扩展字段。key 的类型为 String，value 的类型为 String。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| FailedInfos | Array of FailedInfos | - | 注册失败的用户信息 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserId | String | Your_UserId | 失败用户的 UserId |
| Code | String | UserNotFound | 错误码。参错误码 |
| Message | String | - | 错误详细信息 |
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" }, } ] }
{ "ResponseMetadata": { "RequestId": "Your_RequestId", "Action": "RegisterUsers", "Version": "2020-12-01", "Service": "rtc", "Region": "cn-north-1" }, "Result": { "FailedInfos": [ { "UserId": "10004", "Message": "UserisNotFound", "Code": "UserNotFound" } ] } }
您可访问公共错误码，获取更多错误码信息。