Message Bus¶
The message bus is used to receive events from Wazo. It is provided by an AMQP 0-9-1 broker (namely, RabbitMQ) that is integrated in Wazo.
Usage¶
Websocket¶
The easiest way to listen for events is to use the Wazo WebSocket.
Direct AMQP connection¶
At the moment, the AMQP broker only listen on the 127.0.0.1 address. This means that if you want to connect to the AMQP broker from a distant machine, you must modify the RabbitMQ server configuration, which is not yet an officially supported operation. All events are sent to the xivo exchange.
Otherwise, the default connection information is:
- Virtual host: /
- User name: guest
- User password: guest
- Port: 5672
- Exchange name: xivo
- Exchange type: topic
Example¶
Here’s an example of a simple client, in python, listening for call_created, call_updated, call_ended events:
import kombu
from kombu.mixins import ConsumerMixin
EXCHANGE = kombu.Exchange('xivo', type='topic')
ROUTING_KEY = 'calls.*'
class C(ConsumerMixin):
def __init__(self, connection):
self.connection = connection
def get_consumers(self, Consumer, channel):
return [Consumer(kombu.Queue(exchange=EXCHANGE, routing_key=ROUTING_KEY),
callbacks=[self.on_message])]
def on_message(self, body, message):
print('Received:', body)
message.ack()
def main():
with kombu.Connection('amqp://guest:guest@localhost:5672//') as conn:
try:
C(conn).run()
except KeyboardInterrupt:
return
main()
If you are new to AMQP, you might want to look at the RabbitMQ tutorial.
Notes¶
Things to be aware when writing a client/consumer:
- The published messages are not persistent. When the AMQP broker stops, the messages that are still in queues will be lost.
Changelog¶
19.05¶
- The following messages have been deleted:
- chat_message_event
- chat_message_received
- chat_message_sent
- endpoint_status_update
- user_status_update
19.04¶
- The following messages have been added:
19.03¶
- The following messages have been added:
19.02¶
- The following messages have been added:
18.04¶
- The following messages have been added:
18.02¶
- The following message has been added:
17.17¶
- The following messages have been added:
17.16¶
- The following messages have been added:
17.14¶
- The chat_message_sent bus message has been added.
- The chat_message_received bus message has been added.
- The chat_message_event bus message has been deprecated.
17.08¶
- The plugin_install_progress bus message has been added.
- The plugin_uninstall_progress bus message has been added.
17.01¶
- The favorite_added bus message has been added.
- The favorite_deleted bus message has been added.
16.08¶
- The call_held bus message has been added.
- The call_resumed bus message has been added.
- The user_status_update bus message now uses the user’s UUID instead of the user’s ID.
16.07¶
- The user_created bus message has been added.
- The user_edited bus message has been added.
- The user_deleted bus message has been added.
15.20¶
- The chat_message_event bus message has been added.
15.17¶
- The service_registered_event and service_deregistered_event bus messages have been added.
Events¶
Events that are sent to the bus use a JSON serialization format with the content-type application/json. For example, the CTI call_form_result event looks like this:
{"name": "call_form_result",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {...}}
All events have the same basic structure, namely, a JSON object with 4 keys:
- name
- A string representing the name of the event. Each event type has a unique name.
- required_acl (optional)
- Either a string or null. Currently used by wazo-websocketd to determine if a client can receive the event or not. See the Events Access Control section for more information.
- origin_uuid
- The uuid to identify the message producer.
- data
- The data specific part of the event. This is documented on a per event type; if not this is assumed to be null.
AMI events¶
All AMI events are broadcasted on the bus.
- routing key: ami.<event name>
- event specific data: a dictionary with the content of the AMI event
Example event with binding key QueueMemberStatus:
{
"name": "QueueMemberStatus",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"Status": "1",
"Penalty": "0",
"CallsTaken": "0",
"Skills": "",
"MemberName": "sip\/m3ylhs",
"Queue": "petak",
"LastCall": "0",
"Membership": "static",
"Location": "sip\/m3ylhs",
"Privilege": "agent,all",
"Paused": "0",
"StateInterface": "sip\/m4ylhs"
}
}
auth_user_external_auth_added¶
This event is sent when a user adds an external authentication to its account.
- routing_key: auth.users.{user_uuid}.external.{external_auth_name}.created
- event specific data:
- user_uuid: The user’s UUID
- external_auth_name: The name of the external service
Example:
{
"name": "auth_user_external_auth_added",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"user_uuid": "a1e05585-1421-4397-bd59-9cf9725888e9",
"external_auth_name": "zoho"
}
}
auth_user_external_auth_authorized¶
This event is sent when a user authorizes an oauth2 request on an external authentication plugin.
- routing_key: auth.users.{user_uuid}.external.{external_auth_name}.authorized
- event specific data:
- user_uuid: The user’s UUID
- external_auth_name: The name of the external service
Example:
{
"name": "auth_user_external_auth_authorized",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"user_uuid": "a1e05585-1421-4397-bd59-9cf9725888e9",
"external_auth_name": "zoho"
}
}
auth_user_external_auth_deleted¶
This event is sent when a user removes an external authentication from its account.
- routing_key: auth.users.{user_uuid}.external.{external_auth_name}.deleted
- event specific data:
- user_uuid: The user’s UUID
- external_auth_name: The name of the external service
Example:
{
"name": "auth_user_external_auth_deleted",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"user_uuid": "a1e05585-1421-4397-bd59-9cf9725888e9",
"external_auth_name": "zoho"
}
}
auth_tenant_created¶
This event is published when a tenant is created
- routing_key: auth.tenants.{tenant_uuid}.created
- event specific data:
- uuid: The tenant’s UUID
- name: The name of the tenant
Example:
{
"name": "auth_tenant_created",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"uuid": "a1e05585-1421-4397-bd59-9cf9725888e9",
"name": "<name>"
}
}
auth_tenant_deleted¶
This event is published when a tenant is deleted
- routing_key: auth.tenants.{tenant_uuid}.deleted
- event specific data:
- uuid: The tenant’s UUID
Example:
{
"name": "auth_tenant_deleted",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"uuid": "a1e05585-1421-4397-bd59-9cf9725888e9",
}
}
auth_tenant_updated¶
This event is published when a tenant is updated
- routing_key: auth.tenants.{tenant_uuid}.updated
- event specific data:
- uuid: The tenant’s UUID
- name: The name of the tenant
Example:
{
"name": "auth_tenant_updated",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"uuid": "a1e05585-1421-4397-bd59-9cf9725888e9",
"name": "<name>"
}
}
call_form_result¶
The call_form_result event is sent when a custom call form is submitted via REST API.
- routing key: call_form_result
- event specific data: a dictionary with 2 keys:
- user_id: an integer corresponding to the user ID of the client who saved the call form
- variables: a dictionary holding the content of the form
Example:
{
"name": "call_form_result",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"user_id": 40,
"variables": {
"firstname": "John",
"lastname": "Doe"
}
}
}
agent_status_update¶
The agent_status_update is sent when an agent is logged in or logged out.
- routing key: status.agent
- required ACL: events.statuses.agents
- event specific data: a dictionary with 3 keys:
- agent_id: an integer corresponding to the agent ID of the agent who’s status changed
- status: a string identifying the status
- xivo_id: the uuid of the xivo
Example:
{
"name": "agent_status_update",
"required_acl": "events.statuses.agents",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"agent_id": 42,
"xivo_id": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"status": "logged_in"
}
}
call_created, call_updated, call_ended¶
The events call_created
, call_updated
, call_ended
are sent when a call handled by
wazo-calld is received, connected or hung up.
- routing key: calls.call.created, calls.call.updated, calls.call.ended
- required ACL: events.calls.<user_uuid>
- event specific data: a dictionary with the same fields as the REST API model of Call (See http://api.wazo.community, section wazo-calld)
Example:
{
"name": "call_created",
"required_acl": "events.calls.2e752722-0864-4665-887d-a78a024cf7c7",
"origin_uuid": "08c56466-8f29-45c7-9856-92bf1ba89b82",
"data": {
"bridges": [],
"call_id": "1455123422.8",
"caller_id_name": "Some One",
"caller_id_number": "1001",
"creation_time": "2016-02-10T11:57:02.592-0500",
"status": "Ring",
"talking_to": {},
"user_uuid": "2e752722-0864-4665-887d-a78a024cf7c7"
}
}
call_held¶
This message is sent when a call is placed on hold
- routing key: calls.hold.created
- event specific data:
- call_id: The asterisk channel unique ID
Example:
{"name": "call_held",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {"call_id": "1465572129.31"}}
call_resumed¶
This message is sent when a call is resumed from hold
- routing key: calls.hold.deleted
- event specific data:
- call_id: The asterisk channel unique ID
Example:
{"name": "call_resumed",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {"call_id": "1465572129.31"}}
conference_participant_joined, conference_participant_left¶
Those events are send when a participant joins or leaves a conference room.
- routing keys:
conferences.<conference_id>.participants.joined
conferences.<conference_id>.participants.left
- required ACLs:
events.conferences.<conference_id>.participants.joined
events.conferences.<conference_id>.participants.left
- event specific data:
id
: The ID of the participant inside the conferencecaller_id_name
: The CallerID name of the participantcaller_id_num
: The CallerID number of the participantmuted
: Is the participant muted?answered_time
: Elapsed seconds since the participant joined the conferenceadmin
: Is the participant and admin of the conference?language
: The language of the participantcall_id
: The ID of the call, usable in the/calls
endpoints ofwazo-calld
conference_id
: The ID of the conference
Example:
{
"name": "conference_participant_joined",
"origin_uuid": "08c56466-8f29-45c7-9856-92bf1ba89b82",
"required_acl": "events.conferences.1.participants.joined",
"data": {
"admin": false,
"answered_time": 0,
"call_id": "1547576420.11",
"caller_id_name": "Bernard Marx",
"conference_id": 1,
"id": "1547576420.11",
"language": "fr_FR",
"muted": false
}
}
conference_participant_muted, conference_participant_unmuted¶
Those events are send when a participant joins or leaves a conference room.
- routing key for both events:
conferences.<conference_id>.participants.mute
- required ACL for both events:
events.conferences.<conference_id>.participants.mute
- event specific data:
id
: The ID of the participant inside the conferencecaller_id_name
: The CallerID name of the participantcaller_id_num
: The CallerID number of the participantmuted
: Is the participant muted?admin
: Is the participant and admin of the conference?language
: The language of the participantcall_id
: The ID of the call, usable in the/calls
endpoints ofwazo-calld
conference_id
: The ID of the conference
Example:
{
"name": "conference_participant_muted",
"origin_uuid": "08c56466-8f29-45c7-9856-92bf1ba89b82",
"required_acl": "events.conferences.1.participants.mute",
"data": {
"admin": false,
"call_id": "1547576420.11",
"caller_id_name": "Bernard Marx",
"conference_id": 1,
"id": "1547576420.11",
"language": "fr_FR",
"muted": true
}
}
conference_record_started, conference_record_stopped¶
Those events are send when a participant joins or leaves a conference room.
- routing key for both events:
conferences.<conference_id>.record
- required ACL for both events:
events.conferences.<conference_id>.record
- event specific data:
id
: The ID of the conference
Example:
{
"name": "conference_record_started",
"origin_uuid": "08c56466-8f29-45c7-9856-92bf1ba89b82",
"required_acl": "events.conferences.1.record",
"data": {
"id": 1
}
}
conference_participant_talk_started, conference_participant_talk_stopped¶
Those events are send when a participant joins or leaves a conference room.
- routing key for both events:
conferences.<conference_id>.participants.talk
- required ACL for both events:
events.conferences.<conference_id>.participants.talk
- event specific data:
id
: The ID of the conference
Example:
{
"name": "conference_participant_talk_started",
"origin_uuid": "08c56466-8f29-45c7-9856-92bf1ba89b82",
"required_acl": "events.conferences.1.participants.talk",
"data": {
"admin": false,
"call_id": "1547576420.11",
"caller_id_name": "Bernard Marx",
"conference_id": 1,
"id": "1547576420.11",
"language": "fr_FR",
"muted": false
}
}
favorite_added¶
The favorite_added
event is published when a contact is marked as a favorite by a user.
routing key: directory.<user_uuid>.favorite.created
required ACL: events.directory.<user_uuid>.favorite.created
event specific data:
- xivo_id: The user’s Wazo server UUID
- user_uuid: The user’s UUID
- source: The source in which this contact can be found
- source_entry_id: The ID of the contact within this source
Example:
{
"name": "favorite_added",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"xivo_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"user_uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
"source": "internal",
"source_entry_id": 42
}
}
favorite_deleted¶
The favorite_deleted
event is published when a favorited contact is marked a not
favorite by a user
routing key: directory.<user_uuid>.favorite.deleted
required ACL: events.directory.<user_uuid>.favorite.deleted
event specific data:
- xivo_id: The user’s Wazo server UUID
- user_uuid: The user’s UUID
- source: The source in which this contact can be found
- source_entry_id: The ID of the contact within this source
Example:
{
"name": "favorite_deleted",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"xivo_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"user_uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
"source": "internal",
"source_entry_id": 42
}
}
fax_outbound_created, fax_outbound_user_created¶
Those event are published when a fax is being sent. fax_outbound_user_created
is only sent if
the fax was sent by a user.
routing key:
faxes.outbound.created
andfaxes.outbound.users.{user_uuid}.created
required ACL:
events.faxes.outbound.created
andevents.faxes.outbound.users.{user_uuid}.created
event specific data:
id
: The fax IDcall_id
: The ID of the call that sent the faxextension
: The extension where the fax was sentcontext
: The context where the fax was sentcaller_id
: The Caller ID presented to the fax recipientuser_uuid
: The UUID of the user that sent the faxtenant_uuid
: The tenant UUID from where the fax was sent
Example:
{
"name": "fax_outbound_created",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"id": "1234567.89",
"call_id": "1234567.89",
"context": "internal",
"extension": "1234",
"caller_id": "fax sender <5551234>",
"user_uuid": "3c616e3a-611b-4703-bea8-9be4fc4c9fe4",
"tenant_uuid": "bd72b051-fd14-40be-9c3d-6b5fe65271ca",
}
}
fax_outbound_succeeded, fax_outbound_user_succeeded¶
This event is published when a fax was successfully sent. fax_outbound_user_succeeded
is only
sent if the fax was sent by a user.
routing key:
faxes.outbound.succeeded
andfaxes.outbound.users.{user_uuid}.succeeded
required ACL:
events.faxes.outbound.succeeded
andevents.faxes.outbound.users.{user_uuid}.succeeded
event specific data:
id
: The fax IDcall_id
: The ID of the call that sent the faxextension
: The extension where the fax was sentcontext
: The context where the fax was sentcaller_id
: The Caller ID presented to the fax recipientuser_uuid
: The UUID of the user that sent the faxtenant_uuid
: The tenant UUID from where the fax was sent
Example:
{
"name": "fax_outbound_succeeded",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"id": "1234567.89",
"call_id": "1234567.89",
"context": "internal",
"extension": "1234",
"caller_id": "fax sender <5551234>",
"user_uuid": "3c616e3a-611b-4703-bea8-9be4fc4c9fe4",
"tenant_uuid": "bd72b051-fd14-40be-9c3d-6b5fe65271ca"
}
}
fax_outbound_failed, fax_outbound_user_failed¶
This event is published when a fax was successfully sent. fax_outbound_user_created
is only sent
if the fax was sent by a user.
routing key:
faxes.outbound.failed
andfaxes.outbound.users.{user_uuid}.failed
required ACL:
events.faxes.outbound.failed
andevents.faxes.outbound.users.{user_uuid}.failed
event specific data:
id
: The fax IDcall_id
: The ID of the call that sent the faxextension
: The extension where the fax was sentcontext
: The context where the fax was sentcaller_id
: The Caller ID presented to the fax recipientuser_uuid
: The UUID of the user that sent the faxtenant_uuid
: The tenant UUID from where the fax was senterror
: An explanation of the fax failure
Example:
{
"name": "fax_outbound_failed",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"id": "1234567.89",
"call_id": "1234567.89",
"context": "internal",
"extension": "1234",
"caller_id": "fax sender <5551234>",
"user_uuid": "3c616e3a-611b-4703-bea8-9be4fc4c9fe4",
"tenant_uuid": "bd72b051-fd14-40be-9c3d-6b5fe65271ca",
"error": "recipient did not answer"
}
}
plugin_install_progress¶
The plugin_install_progress event is published during the installation of a plugin.
- routing key: plugin.install.<uuid>.<status>
- required ACL: events.plugin.install.<uuid>.<status>
- event specific data:
- uuid: The installation task UUID
- status: The status of the installation
Example:
{
"name": "plugin_install_progress",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
"status": "completed"
}
}
plugin_uninstall_progress¶
The plugin_uninstall_progress event is published during the removal of a plugin.
- routing key: plugin.uninstall.<uuid>.<status>
- required ACL: events.plugin.uninstall.<uuid>.<status>
- event specific data:
- uuid: The removal task UUID
- status: The status of the removal
Example:
{
"name": "plugin_uninstall_progress",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
"status": "removing"
}
}
relocate_initiated, relocate_answered, relocate_completed, relocate_ended¶
Those events are published during the different steps of a relocate operation.
- routing key:
calls.relocate.XXX
whereXXX
is the event, e.g.calls.relocate.completed
- headers:
"user_uuid:XXX": True
whereXXX
is the initiator’s user UUID
- required ACL:
events.relocates.XXX
where XXX is the initiator’s user UUID - event specific data: a relocate object, see http://api.wazo.community, section
wazo-calld
.
Example:
{
"name": "relocate_completed",
"origin_uuid": "cc5d0d76-687e-40a7-81cf-75e0540d1787",
"data": {
"uuid": "2fb9efc0-95d3-463b-9042-e2cf2183a303",
"completions": [
"answer"
],
"relocated_call": "132456789.1",
"initiator_call": "132456789.2",
"recipient_call": "132456789.3",
"initiator": "b459e3c9-b0a9-43a6-86ff-b4f7d00f6737",
}
}
user_created¶
The user_created event is published when a new user is created.
- routing key: config.user.created
- event specific data: a dictionary with 2 keys
- id: the ID of the created user
- uuid: the UUID of the created user
Example:
{
"name": "user_created",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"id": 42,
"uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2"
}
}
user_deleted¶
The user_deleted event is published when a user is deleted.
- routing key: config.user.deleted
- event specific data: a dictionary with 2 keys
- id: the ID of the deleted user
- uuid: the UUID of the deleted user
Example:
{
"name": "user_deleted",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"id": 42,
"uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2"
}
}
user_edited¶
The user_edited event is published when a user is modified.
- routing key: config.user.edited
- event specific data: a dictionary with 2 keys
- id: the ID of the modified user
- uuid: the UUID of the modified user
Example:
{
"name": "user_edited",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"id": 42,
"uuid": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2"
}
}
users_forwards_<forward_name>_updated¶
The users_forwards_<forward_name>_updated is sent when a user changes his forward using REST API.
- forward_name:
- busy
- noanswer
- unconditional
- routing key: config.users.<user_uuid>.forwards.<forward_name>.updated
- required ACL: events.config.users.<user_uuid>.forwards.<forward_name>.updated
- event specific data: a dictionary with 3 keys
- user_uuid: the user uuid
- enabled: the state of the forward
- destination: the destination of the forward
Example:
{
"name": "users_forwards_busy_updated",
"required_acl": "events.config.users.a1223fe6-bff8-4fb6-a982-f9157dea5094.forwards.busy.updated",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"user_uuid": "a1223fe6-bff8-4fb6-a982-f9157dea5094",
"enabled": true
"destination": "1234"
}
}
users_services_<service_name>_updated¶
The users_services_<service_name>_updated is sent when a user changes his service using REST API.
- service_name:
- dnd
- incallfilter
- routing key: config.users.<user_uuid>.services.<service_name>.updated
- required ACL: events.config.users.<user_uuid>.services.<service_name>.updated
- event specific data: a dictionary with 2 keys
- user_uuid: the user uuid
- enabled: the state of the service
Example:
{
"name": "users_services_dnd_updated",
"required_acl": "events.config.users.a1223fe6-bff8-4fb6-a982-f9157dea5094.services.dnd.updated",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"user_uuid": "a1223fe6-bff8-4fb6-a982-f9157dea5094",
"enabled": true
}
}
service_registered_event¶
The service_registered_event is sent when a service is started.
- routing key: service.registered.<service_name>
- event specific data: a dictionary with 5 keys
- service_name: The name of the started service
- service_id: The consul ID of the started service
- address: The advertised address of the started service
- port: The advertised port of the started service
- tags: The advertised Consul tags of the started service
Example:
{
"name": "service_registered_event",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"service_name": "wazo-dird",
"service_id": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
"address": "192.168.1.42",
"port": 9495,
"tags": ["wazo-dird", "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3", "Québec"]
}
}
service_deregistered_event¶
The service_deregistered_event is sent when a service is stopped.
- routing key: service.deregistered.<service_name>
- event specific data: a dictionary with 3 keys
- service_name: The name of the stopped service
- service_id: The consul ID of the stopped service
- tags: The advertised Consul tags of the stopped service
Example:
{
"name": "service_deregistered_event",
"origin_uuid": "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3",
"data": {
"service_name": "wazo-dird",
"service_id": "8e58d2a7-cfed-4c2e-ac72-14e0b5c26dc2",
"tags": ["wazo-dird", "ca7f87e9-c2c8-5fad-ba1b-c3140ebb9be3", "Québec"]
}
}
user_voicemail_message_created¶
The events user_voicemail_message_created
, user_voicemail_message_updated
,
user_voicemail_message_deleted
are sent when a message is left, updated or deleted from a
voicemail. A distinct message is generated for each user associated to the voicemail: if the
voicemail is not associated to any user, no message is generated.
- routing key: voicemails.messages.created, voicemails.messages.updated, voicemails.messages.deleted
- required ACL: events.users.<user_uuid>.voicemails
- event specific data: a dictionary with the same fields as the REST API model of VoicemailMessage (See http://api.wazo.community, section wazo-calld)
Example:
{
"name": "user_voicemail_message_created",
"required_acl": "events.users.8a709eb7-897f-4183-aa3b-ffa2a74e7e37.voicemails",
"origin_uuid": "3b13295f-9f93-4c19-bd52-015a928a8a2a",
"data": {
"voicemail_id": 1,
"message": {
"timestamp": 1479226725,
"caller_id_num": "1001",
"caller_id_name": "Alice",
"duration": 0,
"folder": {
"type": "new",
"id": 1,
"name": "inbox"
},
"id": "1479226725-00000003"
},
"user_uuid": "8a709eb7-897f-4183-aa3b-ffa2a74e7e37",
"message_id": "1479226725-00000003"
}
}