批量注册用户

POST

https://zim-api.zego.im/

后端注册，开发者可以通过该接口批量帮用户注册 IM 账号，实现消息的接收，以便在用户登录 ZIM 后接收历史消息，常用于教育场景。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [UserRegister]

接口原型参数

https://zim-api.zego.im/?Action=UserRegister

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

UserInfo object[]required

Possible values: <= 100

用户信息，单次最多注册 100 个用户。

Array[

UserId string必填

可选值: <= 32 characters

用户 ID，长度不超过 32 字节。

说明

UserIds 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

UserName string

可选值: <= 256 characters

用户名称，长度不超过 256 字节。

UserAvatar string

可选值: <= 500 characters

用户头像地址，长度不超过 500 字节。

]

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码。

以下仅列出了接口业务逻辑相关的 Code 和 SubCode ，完整返回码请参考全局返回码。

说明

当您发起请求同时注册多个用户时：

如果有 1 个或以上的用户 ID 注册成功，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。

如果全部用户注册失败，Code 会返回相关返回码，具体请参考全局返回码。

Code / SubCode	描述	可能原因	处理建议
660000001	业务类通用错误。	服务端出错。	请重试，或联系 ZEGO 技术支持。
660000002	输入参数错误。	输入的参数缺失或不合法。	请检查输入的参数。
660000012	UserID 长度超过限制。	UserID 最大长度为 32 字节。	请确认 UserID 的长度。
660700001	请求过于频繁。	发起请求频率超过 20 次/秒。	请稍后再试。
660700002	用户已存在。	发送请求的 UserID 已存在。	请避免重复注册相同的 UserID。
660700006	UserName 长度超过限制。	UserName 长度最大为 256 字节。	请确认 UserName 的长度。
660700007	UserAvatar 地址长度超过限制。	UserAvatar 地址长度最大为 500 字节。	请确认 UserAvatar 的长度。

Message string

请求结果的说明信息。

RequestId string

请求 ID。

ErrorList object[]

失败信息列表。

Code 为 0：
ErrorList 为空，全部用户注册成功。
ErrorList 不为空，表示部分用户注册失败，请参考 SubCode、SubMessage 处理。
Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示所有用户都注册失败，全部都是已经存在的用户。

Array[

UserId string

注册失败的 UserID。

SubCode number

用户注册失败的具体返回码，完整返回码请参考 Code 说明或者全局返回码。

SubMessage string

用户注册失败的原因说明。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "SubCode": 660000012,
      "SubMessage": "user length limit"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "SubCode": 660000012,
      "SubMessage": "user length limit"
    }
  ]
}