跳到主要内容

注册用户

客户端在与融云服务端建立连接时必须传入用户在融云的身份验证令牌（Token）。Token 是用户在融云服务中的唯一身份标识，无论是使用融云即时通讯服务或是实时音视频服务，均需要使用该 Token。获取 Token 即表示一个用户在融云服务中完成注册。

获取 Token​

客户端 SDK 不提供获取 Token 的 API。您需要在应用服务端（App Server）集成融云服务端获取 Token API，实现获取 Token 的业务逻辑。

成功获取 Token 后，由您的 App Server 将 Token 分发给客户端。客户端在连接融云服务端时使用。Token 在有效期内都可以正常使用。同一个用户 ID 可多次获取 Token，如果 Token 在有效期内，均可用于连接融云服务。

注意

一旦您在控制台刷新 App Secret，App Key 下已获取的 Token 均会失效。请使用新的 App Secret 生成 API 签名，并重新获取 Token。

请求方法​

通过 App 层定义的用户 ID（userId）换取融云服务中使用的身份验证 Token。同一用户 ID 如需重新获取 Token 使用同一接口。

POST：https://数据中心域名/user/getToken.json

签名规则：所有请求融云服务端 API 接口的请求均需要进行规则校验，详见 API 请求签名。

频率限制：每秒钟限 200 次

输入参数​

获取 Token 时传入的名称（name）和头像（portraitUri），仅供移动端远程推送时使用。如需变更名称和头像信息，建议通过修改用户信息的方法进行变更。在重新获取 Token 时如果传入新的数据，则会覆盖旧的名称与头像数据。

参数类型必传说明
userIdString是App 自行定义的用户 ID，用于换取 Token。支持大小写英文字母与数字的组合，最大长度 64 字节
nameString是推送服务使用的用户名称。不区分符号、英文字符、中文字符，统一限制最多 64 个字符。
portraitUriString否用户头像 URI，最大长度 1024 字节。
注意
  • 在单聊业务中发送消息时，只需要告知融云 userId 即可定位到接收方。考虑到安全问题，强烈建议开发者注册用户不要使用连续的 userId，以防止被恶意利用
  • 部分旧版 Server SDK 中 portraitUri 字段为必填项；若不希望填写该字段，请升级 Server SDK 到最新版，或者传一个固定字符即可，比如："_"

请求示例​

HTTP
POST /user/getToken.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=jlk456j5&name=Ironman&portraitUri=http%3A%2F%2Fabc.com%2Fmyportrait.jpg

返回结果​

返回值返回类型说明
codeInt返回码，200 为正常
tokenString用户身份验证 Token，长度在 256 字节以内，可以保存应用内。Token 中携带 IM 服务动态导航地址，开发者不需要进行处理
userIdString返回输入参数中提供的用户 ID

返回结果示例​

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "code": 200,
  "userId": "jlk456j5",
  "token": "sfd9823ihufi"
}

使用 Token​

融云不管理任何 App 用户信息。用户的注册仅需通过用户 ID 交换 Token 即可。

您的 App 客户端需要在建立 IM 连接时处理 Token 失效的情况，并且在 Token 失效时请求 App Server 重新获取 Token。