WebSocketAPIEvents
Add the following line to your scenario code to use the events:
require(Modules.Ultravox);
Constants
Sent by the server to ask the client or data connection to invoke a tool with the given parameters. https://docs.ultravox.ai/apps/datamessages#clienttoolinvocation-and-dataconnectiontoolinvocation
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Contains information about connector.
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Sent by the server to ask the client or data connection to invoke a tool with the given parameters. https://docs.ultravox.ai/apps/datamessages#clienttoolinvocation-and-dataconnectiontoolinvocation
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Useful for application debugging. https://docs.ultravox.ai/apps/datamessages#debug
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The HTTP response event.
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Used to clear buffered output audio. WebSocket only. https://docs.ultravox.ai/apps/datamessages#playbackclearbuffer
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Indicates the server’s current state. https://docs.ultravox.ai/apps/datamessages#state
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Contains text for an utterance made during the call. https://docs.ultravox.ai/apps/datamessages#transcript
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The unknown event.
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The WebSocket error response event.
Parameters
client:
The Ultravox.WebSocketAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.