Status

Retrieves user current status

Retrieves current status of given user.

GEThttps://HOSTNAME:8887/api/users/{id}/status

Path parameters

id*all of

The unique ID of user.

Response

2004XX

OK

Body

application/json

statusenum

Status of extension:

• ONLINE
• ON_CALL
• OFFLINE

ONLINEON_CALLOFFLINE

presenceenum

The current presence of extension:

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

DO_NOT_DISTURBAVAILABLEAWAYBUSINESS_TRIPLUNCHON_CALLOFFLINE

presence_notestring

The presence note.

registrationarray of object

Collection of registration information.

enable_dndboolean

Do Not Disturb enabled or not.

enable_acbboolean

Automatic Callback enabled or not.

Request

JavaScriptCurlPython

const response = await fetch('https://HOSTNAME:8887/api/users/{id}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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