Vonage Event API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 74 JSON Schema definitions.
Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.
This API exposes
4 operations
across 2 paths,
and defines 118 schemas.
It is described by OpenAPI 3.2.0, at version 5.5.1.
Requests are made against a single base URL, https://api.nexmo.com/v1.
The identity and technical contract details declared by the specification.
timestamp_updated
string
Time of last update
ephemeral_event
object
ephemeral - Ephemeral
3 properties
2 required
messageseen_event_response
object
message:seen - Message seen
7 properties
audiodtmf_body_digit
object
Digit no method and duration
5 properties
3 required
conversation_numbers_sip
object
SIP Channel
4 properties
2 required
audiomuteon_event
object
audio:mute:on - Mute audio
3 properties
2 required
audiorecorddone_event_response
object
audio:record:done - Recording the audio has completed
7 properties
conversation_numbers_vbc
object
VBC Channel
2 properties
2 required
user_properties
object
User properties
1 property
event_media_boolean
object
Media Object with boolean audio
2 properties
audiosaystop_event
object
audio:say:stop - Stop currently playing TTS
3 properties
2 required
audioplaystop_event_response
object
audio:play:stop - Stop currently playing audio
7 properties
timestamp_res_conversation
object
3 properties
rtchangup_event_response
object
rtc:hangup - RTC hangup
7 properties
messageundeliverable_event
object
message:undeliverable - Message undeliverable
3 properties
2 required
conversation_error_not_found
object
Conversation not found
5 properties
rtcanswered_event_response
object
rtc:answered - RTC answered
7 properties
audiodtmf_body_digits_no_method
object
Digits no method and duration
3 properties
1 required
event_links
object
1 property
event_id
string
Event id. This is a progressive integer
audioplay_event_response
object
audio:play - Play Audio
7 properties
conversation_id
string
The unique identifier for this conversation
memberleft_event_response
object
member:left - Member Jeft
7 properties
sipmachine_event_response
object
sip:machine - SIP machine
7 properties
message_body_text
object
Text Message Body
2 properties
audiodtmf_event
object
audio:dtmf - Play DTMF audio
3 properties
2 required
audiorecordstop_event_response
object
audio:record:stop - Stop current recording of audio
7 properties
leg_status_history_knocker
object
Leg Status History with Knocker ID
4 properties
event_whatsapp_channel
object
Whatsapp Channel
3 properties
message_body_custom
object
Custom Message Body
2 properties
memberjoined_event_response
object
member:joined - Member Joined
7 properties
sipstatus_event_response
object
sip:status - Status of SIP
7 properties
audiodtmf_body_digit_no_method
object
Digit no method and duration
3 properties
1 required
message_event
object
message - Message (Text, Image, Audio, Video, File, Template, Custom, VCard, Location, Random)
3 properties
2 required
timestamp_destroyed
string
Time of last update
user_name
stringnull
Unique name for a user
audioearmuffoff_event
object
audio:earmuff:off - Earmuff audio
3 properties
2 required
event_channel
object
5 properties
message_body_file
object
File Message Body
2 properties
audiodtmf_event_response
object
audio:dtmf - Play DTMF audio
7 properties
audiorecord_event_response
object
audio:record - Record the audio
7 properties
sipringing_event_response
object
sip:ringing - SIP ringing
7 properties
audiodtmf_body_digits
object
Digits no method and duration
5 properties
3 required
audioearmuffon_event
object
audio:earmuff:on - Earmuff audio
3 properties
2 required
channel
object
A user who joins a conversation as a member can have one channel per membership. For more details see [channel concept docs](/voice/voice-api/concepts/in-app-c…
event_sms_channel
object
SMS Channel
3 properties
audiosaystop_event_response
object
audio:say:stop - Stop currently playing TTS
7 properties
message_event_response
object
message - Message (Text, Image, Audio, Video, File, Template, Custom, VCard, Location, Random)
7 properties
audioplaystop_event
object
audio:play:stop - Stop currently playing audio
3 properties
2 required
custom_event_response
object
custom - Custom event
7 properties
message_body_template
object
Template Message Body
2 properties
rtcringing_event_response
object
rtc:ringing - RTC ringing
7 properties
audiomuteon_event_response
object
audio:mute:on - Mute audio
7 properties
legstatusupdate_event_response
object
leg:status:update - Leg status update
7 properties
leg_status_complete
object
Leg Status completed
3 properties
page_size
integer
The amount of records returned in this response
user_display_name
stringnull
A string to be displayed as user name. It does not need to be unique
user_image_url
string
An image URL that you associate with the user
sipamdmachine_event_response
object
sip:amdmachine - SIP AMD machine
7 properties
event_audio_channels
object
5 properties
message_body_vcard
object
VCard Message Body
3 properties
audiorecordstop_event
object
audio:record:stop - Stop current recording of audio
3 properties
2 required
ephemeral_event_response
object
ephemeral - Ephemeral
7 properties
messagesubmitted_event
object
message:submitted - Message submitted
3 properties
2 required
audioearmuffon_event_response
object
audio:earmuff:on - Turn on audio earmuff
7 properties
audiospeakingoff_event_response
object
audio:speaking:off - Speaking off
7 properties
audiorecord_event
object
audio:record - Record the audio in the conversation
3 properties
2 required
audiomuteoff_event_response
object
audio:mute:off - Unmute audio
7 properties
audioplaydone_event_response
object
audio:play:done - Playing audio has stopped
7 properties
message_body_location
object
Location Message Body
2 properties
eventdelete_event_response
object
event:delete - Event has been Deleted
7 properties
rtcanswer_event_response
object
rtc:answer - RTC answer
7 properties
conversation_numbers_whatsappvoice
object
Whatsapp Voice Channel
2 properties
event_user
object
5 properties
conversation_numbers_phone
object
Phone Channel
2 properties
2 required
event_invited_member
object
7 properties
messagerejected_event
object
message:rejected - Message rejected
3 properties
2 required
member_channel_from
object
Which channel types this member accepts messages from (if not set, all are accepted)
1 property
siphangup_event_response
object
sip:hangup - SIP hangup
7 properties
messagesubmitted_event_response
object
message:submitted - Message submitted
7 properties
rtctransfer_event_response
object
rtc:transfer - RTC transfer
7 properties
message_body_video
object
Video Message Body
2 properties
audioasrdone_event_response
object
audio:asr:done - Automatic speech recognition completed
7 properties
audiosay_event_response
object
audio:say - Use TTS to speak the given text
7 properties
event_media
object
Media Object with object audio
2 properties
event_viber_channel
object
Viber Channel
3 properties
messagedelivered_event
object
message:delivered - Message delivered
3 properties
2 required
audiospeakingon_event_response
object
audio:speaking:on - Speaking on
7 properties
event_error_not_found
object
Event not found
5 properties
sipanswered_event_response
object
sip:answered - SIP answered
7 properties
memberinvited_event_response
object
member:invited - Member Invited
7 properties
leg_status
object
Leg Status started, ringing or answered
1 property
messageseen_event
object
message:seen - Message seen
3 properties
2 required
rtcstatus_event_response
object
rtc:status - RTC status
7 properties
message_body_audio
object
Audio Message Body
2 properties
audiosay_event
object
audio:say - Use TTS to speak the given text
3 properties
2 required
audioearmuffoff_event_response
object
audio:earmuff:off - Turn off audio earmuff
7 properties
event_messenger_channel
object
Messenger Channel
3 properties
messagedelivered_event_response
object
message:delivered - Message delivered
7 properties
audioplay_event
object
audio:play - Play audio
3 properties
2 required
leg_status_history_member
object
Leg Status History with Member ID
5 properties
messageundeliverable_event_response
object
message:undeliverable - Message undeliverable
7 properties
message_body_random
object
Random Message Body
1 property
conversation_numbers_websocket
object
Websocket Channel
3 properties
2 required
audiosaydone_event_response
object
audio:say:done - Playing TTS has stopped
7 properties
message_body_image
object
Image Message Body
2 properties
membermessagestatus_event_response
object
member:message:status - Member Message Status
7 properties
conversationupdate_event_response
object
conversation:updated - Conversation details have been updated
7 properties
audiomuteoff_event
object
audio:mute:off - Unmute audio
3 properties
2 required
embedded_event_from
object
2 properties
conversation_numbers_app
object
App Channel
2 properties
1 required
membermedia_event_response
object
member:media - Member Media
7 properties
messagerejected_event_response
object
message:rejected - Message rejected
7 properties
audioasrrecorddone_event_response
object
audio:asr:record:done - Automatic speech recognition of recording completed
7 properties
timestamp_created
string
Time of creation
event_mms_channel
object
MMS Channel
3 properties
custom_event
object
custom - Custom event
3 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vonage publishes across the network.
