创建用户

使用 创建用户 从可信后端调用 OpenIM REST 接口。请先在接入准备中配置 API 地址和管理员 Token；接口参数通过请求头和 JSON 请求体传递。

访问 Token 与会话 Token

OpenIM 管理端 REST API 使用管理员 Token 调用，客户端 SDK 登录使用用户 Token。业务后端应负责签发和保管 Token，客户端不应直接持有管理员凭证。

HTTP 请求

POST {API_ADDRESS}/user/user_register

请求示例

curl --request POST "${API_ADDRESS}/user/user_register" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: 1646445464564" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "users": [
    {
      "userID": "11111112",
      "nickname": "yourNickname",
      "faceURL": "yourFaceURL"
    }
  ]
}'

安全提示：管理员 Token 只能保存在可信后端服务中，不能下发到客户端或写入前端代码。客户端登录应使用服务端签发的用户 Token。

请求体

下表列出请求体支持的字段。

{
  "users": [
    {
      "userID": "11111112",
      "nickname": "yourNickname",
      "faceURL": "yourFaceURL"
    }
  ]
}

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准；errCode === 0 表示成功，非 0 表示业务错误。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

错误

如果请求失败，OpenIM 返回错误对象。更多错误码说明见错误码。

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

常见错误场景