作废 Token
设置指定用户在某个时间点之前获取的 Token 失效。
同一个用户 ID 多次获取 Token(例如重新获取 Token),所有已获取 Token 在有效期内均可以正常用于连接。您可以根据业务需求作废指定用户的所有 Token。作废 Token 的操作不影响使用该 Token 建立的已有连接。
- 客户端用户一旦重新连接(包括弱网情况下断线自动重连),会返回 Token 失效错误。此时应重新获取 Token。
- 作废 Token 后,如果 App 用户在客户端使用已废弃的 Token 建立 IM 连接,会返回 Token 失效的错误。此时应重新获取 Token。
Token 有效期
Token 默认为永久有效。有效期可在控制台进行修改。
请求方法
POST: https://数据中心域名/user/token/expire.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 需要设置 Token 失效的用户 ID,支持设置多个最多不超过 20 个。 |
time | Long | 是 | 过期时间戳精确到毫秒,该时间戳前用户获取的 Token 全部失效,使用时间戳之前的 Token 已经在连接中的用户不会立即失效,断开后无法进行连接。 |
请求示例
POST /user/token/expire.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
userId=test1&userId=test2&time=1615362955344
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Int | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}