logo
即时通讯
机器人
ZIM Audio
当前页

查询用户在线状态

GET

https://zim-api.zego.im/

查询用户的在线状态,支持查询单个用户、或批量查询多个用户的在线状态。

说明
调用频率限制:20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [QueryUserOnlineState]

    接口原型参数

    https://zim-api.zego.im/?Action=QueryUserOnlineState

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    UserId string[]必填

    可选值: <= 100

    需要查询的用户 ID 列表(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册),最大支持查询 100 个用户 ID。

    示例:UserId[]=a&UserId[]=b

    说明

    UserId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'。

Responses

OK
Schema
    Code number

    返回码。

    以下仅列出了接口业务逻辑相关的 Code 和 SubCode ,完整返回码请参考 全局返回码

    Code / SubCode说明
    660000011用户个数超过限制。
    660200001不存在的用户 ID。
    用户已经登出。
    用户仅通过服务端注册,并未登录过。
    Message string

    请求结果的说明信息。

    RequestId string

    请求 ID。

    Result object[]
    查询的用户状态结果。用户处于在线状态或离线状态时,通过该字段返回。
  • Array[
  • UserId string

    在线或离线用户的 ID。

    Status string

    可选值: [Online, Offline]

    用户状态,包括:

    • Online:在线。
    • Offline:离线。
  • ]
  • ErrorList object[]
    查询失败列表。用户 ID 不存在或者用户已登出时,通过该字段返回。
    • Code 为 0:
    • ErrorList 为空,全部用户在线状态查询成功。
    • ErrorList 不为空,表示部分用户在线状态查询失败,请参考 SubCode 处理。
    • Code 不为 0:
    • ErrorList 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorList 不为空,表示所有用户在线状态查询失败。
  • Array[
  • UserId string

    不存在的用户 ID 或已登出用户的 ID。

    SubCode number

    查询失败时的返回码,完整返回码请参考 Code 说明或者 全局返回码

  • ]

Previous

在线调试服务端 API

Next

查询用户信息

当前页

返回到顶部