tencent cloud

功能说明

获取用户当前的登录状态。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/openim/query_online_status?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

无需获取详细的登录平台信息

{
   "To_Account": ["id1", "id2", "id3", "id4"]
}

需要获取详细的登录平台信息

{
   "IsNeedDetail": 1,
   "To_Account": ["id1", "id2", "id4"]
}

请求包字段说明

应答包体示例

无需获取详细的登录平台信息

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "QueryResult": [
      {
          "To_Account": "id1",
          "Status": "Offline"
      },
      {
          "To_Account": "id2",
          "Status": "Online"
      },
      {
          "To_Account": "id3",
          "Status": "PushOnline"
      }
  ],
  "ErrorList": [
      {
          "To_Account": "id4",
          "ErrorCode": 70107
      }
  ]    
}

需要获取详细的登录平台信息

{
   "ActionStatus": "OK",
   "ErrorInfo": "",
   "ErrorCode": 0,
   "QueryResult": [
       {
           "To_Account": "id1",
           "Status": "Online",
           "Detail": [
               {
                   "Platform": "iPhone",
                   "Status": "PushOnline"
               },
               {
                   "Platform": "Web",
                   "Status": "Online"
               }
           ]
       },
       {
           "To_Account": "id2",
           "Status": "Offline",
       }        
   ],
   "ErrorList": [
       {
           "To_Account": "id4",
           "ErrorCode": 70107
       }
   ]      
}

请求出错

{
   "ActionStatus": "FAIL",
   "ErrorInfo": "Fail to Parse json data of body, Please check it",
   "ErrorCode": 90001
}

应答包字段说明

注意：

即时通信 IM 后台只会保存 PushOnline 状态7天时间，若从掉线时刻起7天之内未登录过，则进入 Offline 状态。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码、错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

• 导入单个帐号（v4/im_open_login_svc/account_import）
• 导入多个帐号（v4/im_open_login_svc/multiaccount_import）
• 删除帐号（v4/im_open_login_svc/account_delete）
• 查询帐号（v4/im_open_login_svc/account_check）
• 失效帐号登录态（v4/im_open_login_svc/kick）