Users Presence

Gets all connected users presence.

URL

Requires Auth

HTTP Method

/api/v1/users.presence

yes

GET

Query Parameters

Argument

Example

Required

Description

Valid Format(s)

from

2019-05-22T12:11:45.392Z

Optional

The last date you got a status change

ISO 8601 datetime. Timezone, milliseconds and seconds are optional

All users presence example call

If you don't pass from parameter, you'll get a list of all users presence and the result will have a full field with value true indicating that.

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/users.presence

Example Result

{
"users":[
{
"_id":"rocket.cat",
"name":"Rocket.Cat",
"username":"rocket.cat",
"status":"online",
"utcOffset":0,
"avatarETag": "5BB9B5ny5DkKdrwkq"
},
{
"_id":"rocketchat.internal.admin.test",
"name":"RocketChat Internal Admin Test",
"username":"rocketchat.internal.admin.test",
"status":"online",
"utcOffset":-2,
"avatarETag": "iEbEm4bTT327NJjXt"
}
],
"full": true,
"success":true
}

Users presence changed after period example call

If you pass from parameter, you'll get only a list users presence which have changed after the time of from parameter. The full result field will then be false, indicating it's a partial result.

If the value of from parameter is older than 10 minutes, the server will reply with a full result set.

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/users.presence?from=2019-05-22T12:11:45.392Z

Example Result

{
"users":[
{
"_id":"rocket.cat",
"name":"Rocket.Cat",
"username":"rocket.cat",
"status":"online",
"utcOffset":0,
"avatarETag": "5BB9B5ny5DkKdrwkq"
},
{
"_id":"rocketchat.internal.admin.test",
"name":"RocketChat Internal Admin Test",
"username":"rocketchat.internal.admin.test",
"status":"online",
"utcOffset":-2,
"avatarETag": "iEbEm4bTT327NJjXt"
}
],
"full": false,
"success":true
}

Change Log

Version

Description

1.1.0

Added