status_get
Fetch a user’s presence status and custom status text. Use it to show a single user’s status without loading the whole member list.
Request
Section titled “Request”{ "cmd": "status_get", "user": "alice"}| Field | Type | Required | Description |
|---|---|---|---|
user |
string | Yes | Username or user ID. Matching ignores letter case and a leading @. |
Response
Section titled “Response”{ "cmd": "status_get", "username": "alice", "status": { "status": "idle", "text": "back soon" }}username is the stored username, which may differ in case from what you sent. status is filtered for you:
- A user with no open connection shows
{ "status": "offline", "text": "" }. - A user who set
invisibleorofflineshows as offline with empty text, unless you are that user or you havemanage_users. Those viewers see the real status, such asinvisible. - Otherwise you see
online,idle, ordndand the user’s text.
The server also sends status_get frames on its own when someone changes status. See status_set.
Permissions
Section titled “Permissions”Any member can call it.
Errors
Section titled “Errors”val |
When |
|---|---|
User not found |
No account matches user. |
| Validation message | user is missing, not a string, or blank. |
