WebSocketAPIClientParameters
Ultravox.WebSocketAPIClient parameters. Can be passed as arguments to the Ultravox.createWebSocketAPIClient method.
Props
body: Object
Optional. Ultravox request body. See the documentation of the specified endpoint for details.
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: string
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: 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: (event: WebSocketEvents.CLOSE) => void
Optional. A callback function that is called when the WebSocket connection is closed.
pathParameters: Object
Optional. Ultravox request path parameters. See the documentation of the specified endpoint for details.
privacy: boolean
Optional. Whether to enable the privacy functionality.
If privacy is enabled, the logging for the WebSocket connection is disabled.
NOTE: the default value is false.
queryParameters: Object
Optional. Ultravox request query parameters. See the documentation of the specified endpoint for details.
statistics: boolean
Optional. Enables statistics functionality.
trace: boolean
Optional. Whether to enable the tracing functionality.
If tracing is enabled, a URL to the trace file appears in the 'websocket.created' message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.
NOTE: enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigate issues.