Appearance
Presence
Who is online or in a call. Signaling's, read here.
The presence of named identities
GET /v1/presence
In the order named. An identity never seen is offline. Presence is read here and never settled: a lapse this read notices reads offline and is announced by signaling.
Credential: API key — Authorization: Bearer <api_key>.<api_secret>
Rate limit: read, 600 a minute
Parameters
| Name | In | Type | Description |
|---|---|---|---|
identities | query | string[] | Comma-separated, or the parameter repeated. At most 200. 1–200 items. |
Response 200 — One entry per identity named.
| Field | Type | Description |
|---|---|---|
data | PresenceEntry[] |
Errors
| Status | Code |
|---|---|
| 400 | validation_failed, token_ttl_too_long |
| 401 | unauthenticated, token_expired, token_replayed, token_not_yet_valid |
| 403 | permission_denied, app_suspended, quota_exhausted |
| 429 | rate_limited |
| 500 | internal |
Who is reachable now, newest heartbeat first
GET /v1/presence/online
Credential: API key — Authorization: Bearer <api_key>.<api_secret>
Rate limit: read, 600 a minute
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit? | query | integer | 1–100. Default 20. |
cursor? | query | string | The nextCursor of the previous page. 1–512 characters. |
availability? | query | string | One of available, away, dnd. |
Response 200 — A page of identities online or in a call.
| Field | Type | Description |
|---|---|---|
data | PresenceEntry[] | |
nextCursor | string | null | The cursor for the next page; null on the last. |
Errors
| Status | Code |
|---|---|
| 400 | validation_failed, token_ttl_too_long |
| 401 | unauthenticated, token_expired, token_replayed, token_not_yet_valid |
| 403 | permission_denied, app_suspended, quota_exhausted |
| 429 | rate_limited |
| 500 | internal |