1. References
  2. VoxEngine
  3. Ultravox
  4. WebSocketAPIEvents
Rate this page:

WebSocketAPIEvents

Constants

ClientToolInvocation

Copy URL

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

ConnectorInformation

Copy URL

Contains information about connector.

Parameters

DataConnectionToolInvocation

Copy URL

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

Debug

Copy URL

Useful for application debugging. https://docs.ultravox.ai/apps/datamessages#debug

Parameters

HTTPResponse

Copy URL

The HTTP response event.

Parameters

PlaybackClearBuffer

Copy URL

Used to clear buffered output audio. WebSocket only. https://docs.ultravox.ai/apps/datamessages#playbackclearbuffer

Parameters

State

Copy URL

Indicates the server’s current state. https://docs.ultravox.ai/apps/datamessages#state

Parameters

Transcript

Copy URL

Contains text for an utterance made during the call. https://docs.ultravox.ai/apps/datamessages#transcript

Parameters

Unknown

Copy URL

The unknown event.

Parameters

WebSocketError

Copy URL

The WebSocket error response event.

Parameters