创建账号

更新时间: 2023/09/01 07:03:36

您可以通过该接口创建 NERoom 账号并绑定 IM 账号。

功能原理

NERoom登录鉴权.png

  1. App 客户端向 App Server(App自己的服务器)请求 Token。
  2. App Server 通过网易云信 NERoom Server 提供的接口,获取 Token。
  3. 网易云信 NERoom Server 返回 Token 给 App Server。
  4. App Server 将 Token 返回给 App 客户端,App 客户端负责保存 Token。
  5. App 客户端向 NERoom SDK 请求登录 NERoom,传入 userUuid 和 Token。
  6. NERoom SDK 向 NERoom Server 请求校验该 Token 是否正确。
  7. NERoom Server 校验 Token 成功,返回成功的回调给 NERoom SDK。
  8. NERoom SDK 返回成功的回调给 App。

注意事项

  • 如果您之前没有 IM 账号,您可以通过该接口创建 NERoom 账号,并自动创建和 NERoom 账号绑定的 IM 账号。
  • 如果您已经集成了云信 IM SDK,已有云信的 IM 账号,您可以调用该接口创建一个与 IM 账号绑定的 NERoom 账号。
  • 如果需要绑定已有的 IM 账号,请先获得imAccidimToken 的值。

接口请求地址

  • 请求方法:PUT
  • URL:https://roomkit.netease.im/apps/{appKey}/v1/users/{userUuid}
  • Content-Type:application/json

请求参数

  • PUT 请求中 Header 的设置请参见调用方式中的请求结构
  • PUT 请求中 Url和Body 的设置如下:
参数名称 类型 是否必选 示例 描述
appKey String 必选 46499***09cce5 网易云信控制台为应用分配的 App Key。
userUuid String 必选 user01 用户账号,必须保证唯一性。
在复用 IM 账号的场景中,建议设置为 imAccid对应的值。
由小写英文、数字、下划线(_)、@、英文句号(.)和短横线(-)组成,最大长度32个字符。
userToken String 可选 qwer**** 用户的Token。最大长度64个字符,不设置则随机生成。
在复用 IM 账号的场景中,建议设置为 imToken对应的值。
userName String 可选 用户01 用户昵称。最大长度64个字符。如果不设置,则默认设置为 userUuid 的值。
icon String 可选 https://tupian.jpg 用户头像的图片 URL。URL 地址的最大长度为 1000 个字符。
imToken String 可选 0ZNLD4***2N251D1 IM 的 Token。最大长度64个字符,不设置则随机生成。
updateOnConflict Boolean 可选 true userUuid 已经存在时,更新账号信息。不设置则默认不更新。

返回结果

参数名称 类型 示例 描述
code int 0 状态码,0表示成功,具体请参见错误码。
msg String Operation succeeded. 业务结果描述
ts Long 1648021056815 NERoom 服务器处理该请求的完成时间。
该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数。
requestId String 7c4b***e3a4d995 请求的唯一标识。
cost String 48ms 处理该请求所消耗的时间。
data Object - 具体数据。
data.userUuid String user_uuid_00001 用户账号。
data.userToken String 0ZNLD4***2N251D1 用户的 Token。
data.imToken String 0ZNLD4***2N251D1 IM 的 Token。
data.userName String 用户01 用户昵称。如果没有设置参数,则不会返回。
data.icon String https://tupian.jpg 用户的头像。如果没有设置参数,则不会返回。
data.imKey String 46499***09cce5 IM 的 App Key。
data.rtcKey String 46499***09cce5 RTC 的 App Key。

示例

请求示例

PUT https://roomkit.netease.im/apps/46499***09cce5/v1/users/user_uuid_00001

json{
    "userToken":"0ZNLD4***2N251D1",
    "userName":"我是昵称1",
    "imToken":"0ZNLD4***2N251D1",
    "icon":"https://tupian.jpg",
    "updateOnConflict":false
}

返回示例

json{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1657079917019,
    "cost": "146ms",
    "requestId": "8e04a8ed7879***b6a30557279a1b",
    "data": {
        "userUuid": "user_uuid_00001",
        "userToken": "0ZNLD4***2N251D1",
        "imToken": "0ZNLD4***2N251D1",
        "userName":"我是昵称1",
        "icon":"https://tupian.jpg",
        "imKey": "46499***09cce5",
        "rtcKey": "46499***09cce5"
    }
}
此文档是否对你有帮助?
有帮助
去反馈
  • 功能原理
  • 注意事项
  • 接口请求地址
  • 请求参数
  • 返回结果
  • 示例
  • 请求示例
  • 返回示例