AsyncAPI channel · Vonage
· Vonage Voice WebSocket API
/
The single bidirectional WebSocket channel established by Vonage to
the customer-hosted server for the duration of the call leg. Carries
both binary linear-PCM audio frames and JSON text control/event
frames in each direction.
Frames sent by the customer WebSocket server to Vonage.
subscribe
receiveFromVonage
Frames sent by Vonage to the customer WebSocket server.
Messages
OutboundAudioFrame
Binary WebSocket frame carrying linear-PCM audio to play to the caller.
Content-Type: audio/l16
ClearCommand
Instructs Vonage to immediately stop playback and discard queued audio.
Content-Type:
NotifyCommand
Requests a notification when previously-queued audio has finished playing.
Content-Type:
InboundAudioFrame
Binary WebSocket frame carrying linear-PCM audio from the caller.
Content-Type: audio/l16
WebsocketConnectedEvent
Sent by Vonage immediately after the WebSocket handshake completes.
Content-Type:
WebsocketClearedEvent
Acknowledgement that a `clear` command emptied the playback buffer.
Content-Type:
WebsocketNotifyEvent
Notification that a previously-queued audio buffer has finished playing.
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.