Presence: Events

Presence sends events about status changes for an employee. Examples include: being available, going on do not disturb, or their phone starts ringing.

Any presence change is broadcast both directly for the employee as well as any employee group they’re a member of.

Employee Events

Messages sent whenever an employee’s presence status changes.

When applicable, the message payload includes a "busy_since" attribute showing when the employee was dialed.

Name Description
available 
{
  "endpoint": "Employee#1234",
  "live_presence": "available",
  "busy_since": null
}
The employee became available. E.g. by ending a call or turning off do not disturb.
ringing 
{
  "endpoint": "Employee#1234",
  "live_presence": "ringing",
  "busy_since": "2016-09-27T00:00:00.000Z"
}
Someone is calling the employee. E.g. a direct call or through a reception.
busy 
{
  "endpoint": "Employee#1234",
  "live_presence": "busy",
  "busy_since": "2016-09-27T00:00:00.000Z"
}
The employee heeded the call and is on the phone.
do_not_disturb 
{
  "endpoint": "Employee#1234",
  "live_presence": "do_not_disturb",
  "busy_since": "2016-09-27T00:00:00.000Z",
  "do_not_disturb": true,
  "dnd_timeout_at": "2016-09-27T00:00.000Z"
}
The employee doesn’t want to be disturbed. Can include a dnd_timeout_at attribute if the employee set a time for their return.
unknown 
{
  "endpoint": "Employee#1234",
  "live_presence": "unknown",
  "busy_since": null
}
The employee’s presence is unknown. The employee might have enabled live presence privacy or might have no mobile subscription attached.

EmployeeGroup Events

Presence events sent when an employee group’s presence status changes, which happens when an employee within the group has his or her status changed.

See the corresponding employee event for more details.

Name Description
available 
{
  "endpoint": "EmployeeGroup#1234",
  "live_presence": "available"
}
At least one employee is available.
busy 
{
  "endpoint": "EmployeeGroup#1234",
  "live_presence": "busy"
}
None of the employees are available.
unknown 
{
  "endpoint": "EmployeeGroup#1234",
  "live_presence": "unknown"
}
At least one of the employees had an unknown status.