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

功能原理

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 账号，请先获得imAccid 和 imToken 的值。

请求

URI

POST https://{endpoint}/neroom/v3/users

• {endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。
• Content-Type：application/json

Header

请求 Header 的设置请参见 请求结构。

请求参数

请求 Body 的参数说明如下：

参数名称	类型	是否必选	示例	描述
user_uuid	String	必选	user01	用户账号，必须保证唯一性。 在复用 IM 账号的场景中，建议设置为 imAccid对应的值。 由小写英文、数字、下划线(_)、@、英文句号（.）和短横线（-）组成，最大长度32个字符。
user_token	String	可选	qwer****	用户的Token。最大长度64个字符，不设置则随机生成。 在复用 IM 账号的场景中，建议设置为 imToken对应的值。
user_name	String	可选	用户01	用户昵称。最大长度64个字符。如果不设置，则默认设置为 userUuid 的值。
icon	String	可选	https://tupian.jpg	用户头像的图片 URL。URL 地址的最大长度为 1000 个字符。
im_token	String	可选	0ZNLD4***2N251D1	IM 的 Token。最大长度64个字符，不设置则随机生成。

请求示例

json{
    "user_uuid":"user01",
    "user_token":"0ZNLD4***2N251D1",
    "user_name":"我是昵称1",
    "im_token":"0ZNLD4***2N251D1",
    "icon":"https://tupian.jpg"
}

响应

响应参数

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

响应体示例

json{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1657079917019,
    "cost": "146ms",
    "request_id": "8e04a8ed7879***b6a30557279a1b",
    "data": {
        "user_uuid": "user_uuid_00001",
        "user_token": "0ZNLD4***2N251D1",
        "im_token": "0ZNLD4***2N251D1",
        "user_name":"我是昵称1",
        "icon":"https://tupian.jpg"
    }
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理
400	Invalid parameter.	参数错误	检查接口传参