跳到主要内容

查询用户在线状态

主动查询某用户的在线状态。

通过 Server API 接口主动查询某用户的在线状态,接口调用有频率限制,不能频繁调用,可用于管理平台显示用户状态,或用于检查指定用户的客户端是否已成功连接即时通讯服务。

提示

如需即时通讯服务实时发送用户状态变更通知,可开通订阅用户在线状态服务。详见订阅用户在线状态

请求方法

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

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
userIdString用户 ID。

请求示例

POST /user/checkOnline.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=jlk456j5

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber返回码,200 为正常。
statusString用户状态。1 - 用户当前在线。0 - 用户当前不在线。

返回结果示例

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

{"code":200,"status":"1"}