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

WebSocketAPIClient

Methods

addEventListener

Copy URL
addEventListener(event: 
Events
 | 
WebSocketAPIEvents
, callback: 
Function
): 
void

Adds a handler for the specified Ultravox.WebSocketAPIEvents or Ultravox.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

Parameters

Returns

  • type:

    void

clearMediaBuffer

Copy URL
clearMediaBuffer(parameters: 
ClearMediaBufferParameters
): 
void

Clears the Ultravox WebSocket media buffer.

Parameters

Returns

  • type:

    void

clientToolResult

Copy URL
clientToolResult(parameters: 
Object
): 
void

Contains the result of a client tool invocation. https://docs.ultravox.ai/apps/datamessages#clienttoolresult-and-dataconnectiontoolresult

Parameters

  • parameters:

    Object

Returns

  • type:

    void

close

Copy URL
close(): 
void

Closes the Ultravox connection (over WebSocket) or connection attempt.

Returns

  • type:

    void

dataConnectionToolResult

Copy URL
dataConnectionToolResult(parameters: 
Object
): 
void

Contains the result of a client tool invocation. https://docs.ultravox.ai/apps/datamessages#clienttoolresult-and-dataconnectiontoolresult

Parameters

  • parameters:

    Object

Returns

  • type:

    void

forcedAgentMessage

Copy URL
forcedAgentMessage(parameters: 
Object
): 
void

Forces the agent to say a specific message or invoke tools. https://docs.ultravox.ai/apps/datamessages#forcedagentmessage

Parameters

  • parameters:

    Object

Returns

  • type:

    void

hangUp

Copy URL
hangUp(parameters: 
Object
): 
void

Instructs the agent to end the call with an optional farewell message. https://docs.ultravox.ai/apps/datamessages#hangup

Parameters

  • parameters:

    Object

Returns

  • type:

    void

id

Copy URL
id(): 
string

Returns the WebSocketAPIClient id.

Returns

  • type:

    string

inputTextMessage

Deprecated
Copy URL

Used to send a user message to the agent via text. Note: This method is deprecated, use 'userTextMessage' instead.

inputTextMessage(parameters: 
Object
): 
void

Parameters

  • parameters:

    Object

Returns

  • type:

    void

removeEventListener

Copy URL
removeEventListener(event: 
Events
 | 
WebSocketAPIEvents
, callback: 
Function
): 
void

Removes a handler for the specified Ultravox.WebSocketAPIEvents or Ultravox.Events event.

Parameters

Returns

  • type:

    void

sendMediaTo

Copy URL
sendMediaTo(mediaUnit: 
VoxMediaUnit
, parameters: 
SendMediaParameters
): 
void

Starts sending media from the Ultravox (via WebSocket) to the media unit. Ultravox works in real time.

Parameters

Returns

  • type:

    void

setOutputMedium

Copy URL
setOutputMedium(parameters: 
Object
): 
void

Sets server’s output medium to text or voice. https://docs.ultravox.ai/datamessages#setoutputmedium

Parameters

  • parameters:

    Object

Returns

  • type:

    void

stopMediaTo

Copy URL
stopMediaTo(mediaUnit: 
VoxMediaUnit
): 
void

Stops sending media from the Ultravox (via WebSocket) to the media unit.

Parameters

Returns

  • type:

    void

userTextMessage

Copy URL
userTextMessage(parameters: 
Object
): 
void

A user message sent via text. The message appears to the agent as if it came from the user. https://docs.ultravox.ai/apps/datamessages#usertextmessage

Parameters

  • parameters:

    Object

Returns

  • type:

    void

webSocketId

Copy URL
webSocketId(): 
string

Returns the Ultravox WebSocket id.

Returns

  • type:

    string