WebSocketAPIEvents
Constants
ClientToolInvocation
Asks the client to invoke a client tool. https://docs.ultravox.ai/datamessages#clienttoolinvocation
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.
Debug
Useful for application debugging. https://docs.ultravox.ai/datamessages#debug
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.
HTTPResponse
The HTTP response event.
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.
PlaybackClearBuffer
Used to clear buffered output audio. WebSocket only. https://docs.ultravox.ai/datamessages#playbackclearbuffer
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.
State
Indicates the server’s current state. https://docs.ultravox.ai/datamessages#state
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.
Transcript
Contains text for an utterance made during the call. https://docs.ultravox.ai/datamessages#transcript
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.
Unknown
The unknown event.
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
Object
OptionalThe event's data.