AsyncAPI rendering example

asyncapi.md

wazo-calld events 1.0.0 documentation

Table of Contents

• Channels

Channels

publish calld.conferences.users.{user_uuid}.participants.joined

Message

Payload

Name	Type	Description	Accepted values
admin	boolean	Is the partcipant an administrator of this conference?	Any
call_id	string	The participant call ID	Any
caller_id_name	string	The participant Caller ID name	Any
caller_id_number	string	The participant Caller ID number	Any
conference_id	integer	The conference ID	Any
id	string	The participant ID	Any
join_time	integer	When the participant joined the conference	Any
language	string	The participant language	Any
muted	boolean	Is the partcipant muted in this conference?	Any
user_uuid	string	The participant user UUID	Any

Example of payload (generated)

{
  "admin": true,
  "call_id": "string",
  "caller_id_name": "string",
  "caller_id_number": "string",
  "conference_id": 0,
  "id": "string",
  "join_time": 0,
  "language": "string",
  "muted": true,
  "user_uuid": "string"
}

publish calld.conferences.users.{user_uuid}.participants.left

Message

Payload

Name	Type	Description	Accepted values
admin	boolean	Is the partcipant an administrator of this conference?	Any
call_id	string	The participant call ID	Any
caller_id_name	string	The participant Caller ID name	Any
caller_id_number	string	The participant Caller ID number	Any
conference_id	integer	The conference ID	Any
id	string	The participant ID	Any
join_time	integer	When the participant joined the conference	Any
language	string	The participant language	Any
muted	boolean	Is the partcipant muted in this conference?	Any
user_uuid	string	The participant user UUID	Any

Example of payload (generated)

{
  "admin": true,
  "call_id": "string",
  "caller_id_name": "string",
  "caller_id_number": "string",
  "conference_id": 0,
  "id": "string",
  "join_time": 0,
  "language": "string",
  "muted": true,
  "user_uuid": "string"
}

publish calld.conferences.{conference_id}.participants.joined

Message

Payload

Name	Type	Description	Accepted values
admin	boolean	Is the partcipant an administrator of this conference?	Any
call_id	string	The participant call ID	Any
caller_id_name	string	The participant Caller ID name	Any
caller_id_number	string	The participant Caller ID number	Any
conference_id	integer	The conference ID	Any
id	string	The participant ID	Any
join_time	integer	When the participant joined the conference	Any
language	string	The participant language	Any
muted	boolean	Is the partcipant muted in this conference?	Any
user_uuid	string	The participant user UUID	Any

Example of payload (generated)

{
  "admin": true,
  "call_id": "string",
  "caller_id_name": "string",
  "caller_id_number": "string",
  "conference_id": 0,
  "id": "string",
  "join_time": 0,
  "language": "string",
  "muted": true,
  "user_uuid": "string"
}

publish calld.conferences.{conference_id}.participants.left

Message

Payload

Name	Type	Description	Accepted values
admin	boolean	Is the partcipant an administrator of this conference?	Any
call_id	string	The participant call ID	Any
caller_id_name	string	The participant Caller ID name	Any
caller_id_number	string	The participant Caller ID number	Any
conference_id	integer	The conference ID	Any
id	string	The participant ID	Any
join_time	integer	When the participant joined the conference	Any
language	string	The participant language	Any
muted	boolean	Is the partcipant muted in this conference?	Any
user_uuid	string	The participant user UUID	Any

Example of payload (generated)

{
  "admin": true,
  "call_id": "string",
  "caller_id_name": "string",
  "caller_id_number": "string",
  "conference_id": 0,
  "id": "string",
  "join_time": 0,
  "language": "string",
  "muted": true,
  "user_uuid": "string"
}

publish calld.conferences.{conference_id}.participants.mute

Message

Payload

Name	Type	Description	Accepted values
Message Payload	</td> <td></td> <td><em>Any</em></td> </tr>

Example of payload (generated)

{
  "admin": true,
  "call_id": "string",
  "caller_id_name": "string",
  "caller_id_number": "string",
  "conference_id": 0,
  "id": "string",
  "join_time": 0,
  "language": "string",
  "muted": true,
  "user_uuid": "string"
}

publish calld.conferences.{conference_id}.participants.talk

Message

Payload

Name	Type	Description	Accepted values
Message Payload	</td> <td></td> <td><em>Any</em></td> </tr>

Example of payload (generated)

{
  "admin": true,
  "call_id": "string",
  "caller_id_name": "string",
  "caller_id_number": "string",
  "conference_id": 0,
  "id": "string",
  "join_time": 0,
  "language": "string",
  "muted": true,
  "user_uuid": "string"
}

publish calld.conferences.{conference_id}.record

Message

Payload

Name	Type	Description	Accepted values
Message Payload	</td> <td></td> <td><em>Any</em></td> </tr>

Example of payload (generated)

{
  "id": "string"
}

Messages

conference_participant_joined

A new participant joined a conference

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_participant_left

A participant left a conference

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_participant_muted

A conference participant was muted

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_participant_talk_started

A conference participant started talking

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_participant_talk_stopped

A conference participant stopped talking

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_participant_unmuted

A conference participant was muted

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_record_started

The recording of a conference has started

Payload

Name	Type	Description	Accepted values
id	string		Any

conference_record_stopped

The recording of a conference has stopped

Payload

Name	Type	Description	Accepted values
id	string		Any

conference_user_participant_joined

A new participant joined a conference. This event is accessible to users.

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference_user_participant_left

A participant left a conference. This event is accessible to users.

Payload

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

Schemas

conference-participant

Name	Type	Description	Accepted values
admin	boolean		Any
call_id	string		Any
caller_id_name	string		Any
caller_id_number	string		Any
conference_id	integer		Any
id	string		Any
join_time	integer		Any
language	string		Any
muted	boolean		Any
user_uuid	string		Any

conference-record

Name	Type	Description	Accepted values
id	string		Any