即时通讯
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • Unity3D
  • uni-app
  • React Native
  • 产品简介
  • 下载
  • 快速开始
    • 跑通示例源码
    • 实现基本消息收发
  • 用户相关
  • 房间相关
  • 群组相关
  • 消息相关
  • 呼叫邀请
  • 会话管理
  • 缓存管理
  • 离线推送
  • 语音组件
  • 客户端 API
  • 服务端 API
  • 迁移方案
  • SDK 错误码
  • 常见问题
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 用户相关
  • 批量注册用户

批量注册用户

更新时间:2024-04-10 16:13

描述

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

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

接口原型

  • 请求方法:POST
  • 请求地址:https://zim-api.zego.im/?Action=UserRegister
  • 传输协议:HTTPS

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
UserInfo
Array of Object
用户信息,单次最多注册 100 个用户。
UserId
String
用户 ID,长度不超过 32 字节。
UserName
String
用户名称,长度不超过 64 字节。
UserAvatar
String
用户头像地址,长度不超过 500 字节。

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

请求示例

  • 请求地址 URL:

    https://zim-api.zego.im/?Action=UserRegister
    &<公共请求参数>
  • 请求消息体:

    {
        "UserInfo":[
        {
            "UserId": "aaa",
            "UserName": "userNamea",
            "UserAvatar": "http"
        },
        {
            "UserId": "bbb",
            "UserName": "userNameb",
            "UserAvatar": "http"
        }
        ]
    }

响应参数

参数 类型 描述
Code
Number
返回码。

当您发起请求同时注册多个用户时:
  • 如果有 1 个或以上的用户 ID 注册成功,Code 都会返回 0。此时请参考 ErrorList 中的具体信息,确认操作结果。
  • 如果全部用户注册失败,Code 会返回相关返回码,具体请参考 全局返回码
Message
String
请求结果的说明信息。
RequestId
String
请求 ID。
ErrorList
Array of Object
失败信息列表。

  • Code 为 0:
    • ErrorList 为空,全部用户注册成功。
    • ErrorList 不为空,表示部分用户注册失败,请参考 SubCode、SubMessage 处理。
  • Code 不为 0:
    • ErrorList 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorList 不为空,表示所有用户都注册失败,全部都是已经存在的用户。
UserID
String
注册失败的 UserID。
SubCode
Number
用户注册失败的具体返回码。
SubMessage
String
用户注册失败的原因说明。

响应示例

{
    "Code":0,   // 同时注册多个用户时,如果有 1 个或以上的用户 ID 注册成功,Code 都会返回 0。此时请参考 ErrorList 中的具体信息进一步确认。
    "Message":"success",
    "RequestId":"343649807833778782",
    "ErrorList": [
       {
           "UserId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
           "SubCode": 660000012,
           "SubMessage":"user length limit"
       }
     ] 
}

返回码

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

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