WebSocketAPIClientParameters
Ultravox.WebSocketAPIClient parameters. Can be passed as arguments to the Ultravox.createWebSocketAPIClient method.
Props
body
body: Object
Optional. Ultravox request body. See the documentation of the specified endpoint for details.
endpoint
endpoint: Ultravox HTTP endpoint. Note that Ultravox Call is created by the specified endpoint HTTP invocation, the response data for which can be handled in the WebSocketAPIEvents.HTTPResponse event.
joinUrl
joinUrl: string
| undefined
Optional. Ultravox URL returned from the https://docs.ultravox.ai/api-reference/calls/calls-post or https://docs.ultravox.ai/api-reference/agents/agents-calls-post requests. Note that you must specify the https://docs.ultravox.ai/api-reference/calls/calls-post#body-medium with 'serverWebSocket' parameters on the call creating. See the documentation for details.
onWebSocketClose
onWebSocketClose: (event: WebSocketEvents.CLOSE) => void
| undefined
Optional. A callback function that is called when the WebSocket connection is closed.
pathParameters
pathParameters: Object
Optional. Ultravox request path parameters. See the documentation of the specified endpoint for details.
queryParameters
queryParameters: Object
Optional. Ultravox request query parameters. See the documentation of the specified endpoint for details.
statistics
statistics: false
| undefined
| true
Optional. Enables statistics functionality.
trace
trace: false
| undefined
| true
Optional. Enables trace functionality.