QBus Events

Content

This document lists the events of Bloom Enterprise that can be listened to using Q-Bus.

Introduction

Bloom Enterprise events can be listened to using Q-Bus. To perceive what is happening, the following events should be registered to:

QMSERVICESINFO_$LOCATION_ID$
QMCALLTICKETRESPONSE_$LOCATION_ID$
QMCALLCANCELLEDTICKETRESPONSE_$LOCATION_ID$
QMCALLPAUSEDTICKETRESPONSE_$LOCATION_ID$
QMRECALLTICKETRESPONSE_$LOCATION_ID$
QMCALLONETICKETRESPONSE_$LOCATION_ID$
QMENDCALL_$LOCATION_ID$
QMCANCELTICKETRESPONSE_$LOCATION_ID$
QMRELOAD_$DEVICE_D$
DEVICERELOAD_$DEVICE_ID$
QMRESTARTALL_$LOCATION_ID$
QMCLOSESERVICE
QMOPENSERVICE

The above-mentioned events will be described in chapter 2, along with the messages sent within them.

The tag $Location_ID$ must be replaced with a valid location ID, and this will filter the events by location.

The tag $Device_ID$ must be replaced with valid device ID, and this will filter the events by device.

To understand the tickets satte flag. the tickets state can be of the following types:

TICKET_QUEUED = 0
TICKET_ANSWERED = 1
TICKET_SUSPENDED = 2
TICKET_TERMINATED = 3

Events

QMServicesInfo_$Location_ID$

This event is sent when there is a change in the ticket lists: ticket generated, called, transferred, paused, ended, or cancelled.

note

Each block refers to a service ( id is the service ID).

[
  {
    "id": "451da9c2-8a8c-4cc2-9e4e-2f28ba162928",
    "waiting_count": 2,
    "waiting_avg_time": 8.3333,
    "paused_count": 0,
    "cancelled_count": 0
  },
  {
    "id": "0885b54b-b8c9-4515-bd76-37e50cc096fe",
    "waiting_count": 0,
    "waiting_avg_time": 0,
    "paused_count": 0,
    "cancelled_count": 0
  },
  {
    "id": "11dabc77-fa43-4fb9-af72-babb8d2ccbc3",
    "waiting_count": 0,
    "waiting_avg_time": 0,
    "paused_count": 0,
    "cancelled_count": 0
  }
]

QMCallTicketResponse_$Location_ID$

This event is sent when a ticket is CALLED.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
  <qmpad_id>e42b8f80-3ca3-48f3-87be-389ec971b2a9</qmpad_id>
  <message><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <ticket>
  <id>2a5ff3b4-98ec-11e9-9dff-241c040cf020</id>
  <dst_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</dst_service_id>
  <dst_user_id/>
  <dst_desk_id/>
  <ticket_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</ticket_service_id>
  <desk_id>d25bb47b-8dcc-11e9-b0dd-241c040cf020</desk_id>
  <number>3</number>
  <date>2019-06-27 15:59:30</date>
  <cancelled>0</cancelled>
  <transferred>0</transferred>
  <state>1</state>
  <distributor_path/>
  <device_id/>
  <answer_id>2a60e506-98ec-11e9-9dff-241c040cf020</answer_id>
  <call_date>2019-06-27 15:59:30</call_date>
  <end_date>2019-06-27 15:59:40</end_date>
  <user_id>e59d0759-f4ea-4774-993b-a0e73fd88511</user_id>
  <note/>
  <number_of_waiting_tickets>0</number_of_waiting_tickets>
  <waiting_time>00:00:00</waiting_time>
  <custom_field/>
  <app_id>null</app_id>
  <app_displayname>null</app_displayname>
  <clientname/>
  <lang/>
  <flags>0</flags>
  </ticket>
  ]]></message>
</response>

QMCallCancelledTicketResponse_$Location_ID$

This event is sent when a CANCELLED ticket is CALLED.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
  <qmpad_id>54c24675-c978-4a78-bd17-6155e06857f5</qmpad_id>
  <message><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <ticket>
  <id>16c47167-98ee-11e9-9dff-241c040cf020</id>
  <dst_service_id>43b73789-7419-4d9f-bb73-793c97d433d9</dst_service_id>
  <dst_user_id/>
  <dst_desk_id/>
  <ticket_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</ticket_service_id>
  <desk_id>d25bb47b-8dcc-11e9-b0dd-241c040cf020</desk_id>
  <number>7</number>
  <date>2019-06-27 16:13:16</date>
  <cancelled>0</cancelled>
  <transferred>1</transferred>
  <state>1</state>
  <distributor_path/>
  <device_id/>
  <answer_id>68d89773-98ee-11e9-9dff-241c040cf020</answer_id>
  <call_date>2019-06-27 16:15:34</call_date>
  <end_date>2019-06-27 16:15:44</end_date>
  <user_id>e59d0759-f4ea-4774-993b-a0e73fd88511</user_id>
  <note/>
  <number_of_waiting_tickets>0</number_of_waiting_tickets>
  <waiting_time>00:02:18</waiting_time>
  <custom_field>false</custom_field>
  <app_id>null</app_id>
  <app_displayname>null</app_displayname>
  <clientname/>
  <lang/>
  <flags>0</flags>
  </ticket>
  ]]></message>
</response>

QMCallPausedTicketResponse_$Location_ID$

This event is sent when a PAUSED ticket is CALLED.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
  <qmpad_id>54c24675-c978-4a78-bd17-6155e06857f5</qmpad_id>
  <message><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <ticket>
  <id>16c47167-98ee-11e9-9dff-241c040cf020</id>
  <dst_service_id>43b73789-7419-4d9f-bb73-793c97d433d9</dst_service_id>
  <dst_user_id/>
  <dst_desk_id/>
  <ticket_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</ticket_service_id>
  <desk_id>d25bb47b-8dcc-11e9-b0dd-241c040cf020</desk_id>
  <number>7</number>
  <date>2019-06-27 16:13:16</date>
  <cancelled>0</cancelled>
  <transferred>1</transferred>
  <state>1</state>
  <distributor_path/>
  <device_id/>
  <answer_id>3c37fe79-98ee-11e9-9dff-241c040cf020</answer_id>
  <call_date>2019-06-27 16:14:19</call_date>
  <end_date>2019-06-27 16:14:29</end_date>
  <user_id>e59d0759-f4ea-4774-993b-a0e73fd88511</user_id>
  <note/>
  <number_of_waiting_tickets>0</number_of_waiting_tickets>
  <waiting_time>00:01:03</waiting_time>
  <custom_field>false</custom_field>
  <app_id>null</app_id>
  <app_displayname>null</app_displayname>
  <clientname/>
  <lang/>
  <flags>0</flags>
  </ticket>
  ]]></message>
</response>

QMRecallTicketResponse_$Location_ID$

This event is sent when a ticket is RECALLED.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
  <qmpad_id>54c24675-c978-4a78-bd17-6155e06857f5</qmpad_id>
  <message><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <ticket>
  <id>16c47167-98ee-11e9-9dff-241c040cf020</id>
  <dst_service_id>43b73789-7419-4d9f-bb73-793c97d433d9</dst_service_id>
  <dst_user_id/>
  <dst_desk_id/>
  <ticket_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</ticket_service_id>
  <desk_id>d25bb47b-8dcc-11e9-b0dd-241c040cf020</desk_id>
  <number>7</number>
  <date>2019-06-27 16:13:16</date>
  <cancelled>0</cancelled>
  <transferred>1</transferred>
  <state>1</state>
  <distributor_path/>
  <device_id/>
  <answer_id>3c37fe79-98ee-11e9-9dff-241c040cf020</answer_id>
  <call_date>2019-06-27 16:14:19</call_date>
  <end_date>2019-06-27 16:14:29</end_date>
  <user_id>e59d0759-f4ea-4774-993b-a0e73fd88511</user_id>
  <note/>
  <number_of_waiting_tickets>0</number_of_waiting_tickets>
  <waiting_time>00:01:03</waiting_time>
  <custom_field>false</custom_field>
  <app_id/>
  <app_displayname/>
  <clientname/>
  <lang/>
  <flags>0</flags>
  </ticket>
  ]]></message>
</response>

QMCallOneTicketResponse_$Location_ID$

This event is sent when a SPECIFIC ticket is CALLED.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
  <qmpad_id>54c24675-c978-4a78-bd17-6155e06857f5</qmpad_id>
  <message><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <ticket>
  <id>16c47167-98ee-11e9-9dff-241c040cf020</id>
  <dst_service_id>43b73789-7419-4d9f-bb73-793c97d433d9</dst_service_id>
  <dst_user_id/>
  <dst_desk_id/>
  <ticket_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</ticket_service_id>
  <desk_id>d25bb47b-8dcc-11e9-b0dd-241c040cf020</desk_id>
  <number>7</number>
  <date>2019-06-27 16:13:16</date>
  <cancelled>0</cancelled>
  <transferred>1</transferred>
  <state>1</state>
  <distributor_path/>
  <device_id/>
  <answer_id>202105f2-98ee-11e9-9dff-241c040cf020</answer_id>
  <call_date>2019-06-27 16:13:32</call_date>
  <end_date>2019-06-27 16:13:42</end_date>
  <user_id>e59d0759-f4ea-4774-993b-a0e73fd88511</user_id>
  <note/>
  <number_of_waiting_tickets>0</number_of_waiting_tickets>
  <waiting_time>00:00:16</waiting_time>
  <custom_field>false</custom_field>
  <app_id>null</app_id>
  <app_displayname>null</app_displayname>
  <clientname/>
  <lang/>
  <flags>0</flags>
  </ticket>
  ]]></message>
</response>

QMEndCall_$Location_ID$

This event is sent when a ticket is TERMINATED and contains the ID of the answer.

QMCancelTicketResponse_$Location_ID$

This event is sent when a ticket is CANCELLED.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
  <qmpad_id>54c24675-c978-4a78-bd17-6155e06857f5</qmpad_id>
  <message><![CDATA[OK]]></message>
  <ticket_info><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <ticket>
  <id>16c47167-98ee-11e9-9dff-241c040cf020</id>
  <dst_service_id>43b73789-7419-4d9f-bb73-793c97d433d9</dst_service_id>
  <dst_user_id/>
  <dst_desk_id/>
  <ticket_service_id>39ab9bbd-f04d-41f0-9e6a-7cb661172d5b</ticket_service_id>
  <desk_id>d25bb47b-8dcc-11e9-b0dd-241c040cf020</desk_id>
  <number>7</number>
  <date>2019-06-27 16:13:16</date>
  <cancelled>1</cancelled>
  <transferred>1</transferred>
  <state>3</state>
  <distributor_path/>
  <device_id/>
  <answer_id>68d89773-98ee-11e9-9dff-241c040cf020</answer_id>
  <call_date>2019-06-27 16:15:34</call_date>
  <end_date>2019-06-27 16:16:27</end_date>
  <user_id>e59d0759-f4ea-4774-993b-a0e73fd88511</user_id>
  <note/>
  <number_of_waiting_tickets>0</number_of_waiting_tickets>
  <waiting_time>null</waiting_time>
  <custom_field>false</custom_field>
  <app_id/>
  <app_displayname/>
  <clientname/>
  <lang/>
  <flags>0</flags>
  </ticket>
  ]]></ticket_info>
</response>

QMReload_$Device_ID$

This event indicates that something in the queueing status of the specified device has changed, and it should reload the configurations.

DeviceReload_$Device_ID$

This event indicates that something in the configurations of the specified device has changed, and it should reload the configurations.

QMRestartAll_$Location_ID$

This event indicates that something in the queueing status of the specified location has changed.

QMCloseService

This event indicates that a Ticket Reset was performed (message contains the ID of the service that closed).

QMOpenService

This event indicates that a ticket reset was performed (message contains the ID of the service that opened).

Content​

Introduction​

Events​

QMServicesInfo_$Location_ID$​

QMCallTicketResponse_$Location_ID$​

QMCallCancelledTicketResponse_$Location_ID$​

QMCallPausedTicketResponse_$Location_ID$​

QMRecallTicketResponse_$Location_ID$​

QMCallOneTicketResponse_$Location_ID$​

QMEndCall_$Location_ID$​

QMCancelTicketResponse_$Location_ID$​

QMReload_$Device_ID$​

DeviceReload_$Device_ID$​

QMRestartAll_$Location_ID$​

QMCloseService​

QMOpenService​