tencent cloud

Feature Description

This API is used to query the current login status of a user.

API Call Description

Sample request URL

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

Request parameters

The following is a list of the parameters commonly used when calling this API and their descriptions. For more parameters, see the RESTful API Overview.

Maximum call frequency

This API can be called up to 200 times per second.

Sample request packets

When detailed login platform information is not needed

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

When detailed login platform information is needed

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

Request packet fields

Sample response packet body

When detailed login platform information is not needed

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

When detailed login platform information is needed

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

Request error

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

Response packet fields

Note：

The IM backend stores the PushOnline state for only 7 days. If a user has not logged in to the client within 7 days since the previous login, the user enters the Offline state.

Error Codes

The HTTP return code for this API is 200 unless an network error such as error 502 occurs. The actual error code and error information are indicated by ErrorCode and ErrorInfo respectively in the response packet body.
For public error codes 60000 to 79999, see Error Codes.
The private error codes for this API are as follows:

API Debugging Tool

To debug this API, you can use the Online RESTful API Debugging Tool.

References

• Importing an Account (v4/im_open_login_svc/account_import)
• Batch Importing Multiple Accounts (v4/im_open_login_svc/multiaccount_import)
• Deleting an Account (v4/im_open_login_svc/account_delete)
• Querying an Account (v4/im_open_login_svc/account_check)
• Invalidating the Login Status of an Account (v4/im_open_login_svc/kick)