API 参考
圈组

刷新Token

更新时间: 2024/07/18 10:13:31

网易云信 IM 服务端支持两种刷新 Token 的方式,即指定 Token 刷新和不指定随机刷新。如果需要主动更新 Token,或者 Token 不慎泄露需要修改 Token,可调用如下两个 API 进行更新。

指定Token

功能描述

通过该接口可以将用户账号更新到指定的token。更新后,需要同时更新自身服务器上维护的Token,此外也要确保客户端再次登录时携带的Token是最新的。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

httpPOST https://api.netease.im/nimserver/user/update.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数名称 类型 字符串长度上限 是否必选 示例 描述
accid String 32 必选 "123456" 待刷新的云信账号
props String 1024 选填 {"k":"v"} 该参数已不建议使用。
token String 128 选填 "abcdef" 新的token

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk4***9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigw***3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf***f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&token=123456' 'https://api.netease.im/nimserver/user/update.action'

刷新成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200
}

刷新失败返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "zhangsan not register"
}

不指定Token

功能描述

通过该接口可以将用户账号更新到由云信服务器随机生成的token。更新后,需要同时更新自身服务器上维护的token,此外也要确保客户端再次登录时携带的token是最新的。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

httpPOST https://api.netease.im/nimserver/user/refreshToken.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数名称 类型 字符串长度上限 是否必选 示例 描述
accid String 32 必选 "123456" 待刷新的云信账号

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9v***1kglw0803mgq3" -H "Nonce: 4tgggergig***323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962c***6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/user/refreshToken.action'

刷新成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "info": {
        "accid": "zhangsan",
        "token": "07b9ee85767990779707af4030******"
    }
}

刷新失败返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "zhangsan not register"
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 指定Token
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 刷新成功返回示例
  • 刷新失败返回示例
  • 不指定Token
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 刷新成功返回示例
  • 刷新失败返回示例
  • 状态码