Chat - Presence Events

This collection of events can inform you of your chat agents activity when using the Chat API or Engagement Cloud chat tool.

Available

Indicates that a chat agent is ready and available to handle chats.

Examples

{
  "eventId": "9198429c-dd64-483a-8011-90274429dafc",
  "accountId": 1234,
  "apiSpaceId": "a1d1780d-8440-480a-b268-20b1eb50a4ff",
  "name": "presence.available",
  "profileId": "PLATFORMUSER\\[email protected]",
  "timestamp": "2018-03-16T16:51:19.607Z"
}

Away

Indicates that a chat agent has flagged themselves as away and will not have new chats allocated to them in this status.

Examples

{
  "eventId": "f0144a9d-5597-45f1-80f5-4e92834374ed",
  "accountId": 1234,
  "apiSpaceId": "a1d1780d-8440-480a-b268-20b1eb50a4ff",
  "name": "presence.away",
  "profileId": "PLATFORMUSER\\[email protected]",
  "timestamp": "2018-03-16T16:54:11.961Z"
}

Offline

Indicates that a chat agent is offline and no longer has the chat tool open.

Examples

{
  "eventId": "a8fd84af-917a-4c62-bea9-b099225854fd",
  "accountId": 1234,
  "apiSpaceId": "a124cf6e-4352-4b26-a71a-c3032bea7a01",
  "name": "presence.offline",
  "profileId": "PLATFORMUSER\\[email protected]",
  "timestamp": "2018-03-16T16:51:19.439Z"
}