Status

Retrieves user current status

get

Retrieves current status of given user.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

statusstring · enumOptional

Status of extension:

• ONLINE
• ON_CALL
• OFFLINE

Possible values:

presencestring · enumOptional

The current presence of extension:

• DO_NOT_DISTURB:
• AVAILABLE:
• AWAY:
• BUSINESS_TRIP:
• LUNCH:
• ON_CALL
• OFFLINE

Possible values:

presence_notestring · max: 128Optional

The presence note.

enable_dndbooleanOptional

Do Not Disturb enabled or not.

enable_acbbooleanOptional

Automatic Callback enabled or not.

4XX

Error

get/users/{id}/status

HTTPcURLJavaScriptPython

GET /api/users/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ONLINE",
  "presence": "DO_NOT_DISTURB",
  "presence_note": "text",
  "registration": [
    {
      "instance_id": "text",
      "user_agent": "text",
      "application": "text",
      "ip": "text",
      "enable_push": true,
      "contact_address": "text"
    }
  ],
  "enable_dnd": true,
  "enable_acb": true
}