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/querystate?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table lists and describes only the parameters to be modified when this API is called. For more parameters, see REST API Overview.

Maximum call frequency

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

Sample request packet

When detailed login platform information is not needed

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

When detailed login platform information is needed

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

Description of fields in a request packet

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"
      }
  ]
}

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",
       }        
   ]
}

Request error

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

Description of fields in a response packet

Note：

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

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 common 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 REST API Debugging Tool.