Skip to main content

Overview​

Retrieves the user online status.

Request​

Authentication: Add authentication headers to the request. See Authentication

Method: POST

Rate limit: 100 requests/second

Endpoint: https://API domain/jim/users/onlinestatus

Content-Type: application/json

Request parameters​

ParameterData typeRequiredDescription
user_idsarrayYesUser ID list.

Request example​

POST /jim/users/onlinestatus HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
"user_ids":["userid1","userid2","userid3"]
}

Response example​

{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"is_online":true
},{
"user_id":"userid2",
"is_online":false
},{
"user_id":"userid3",
"is_online":false
}
]
}
}

Response codes​

Response codesDescription