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

WebSocketAPIClientParameters

Ultravox.WebSocketAPIClient parameters. Can be passed as arguments to the Ultravox.createWebSocketAPIClient method.

Props

authorizations

Copy URL
authorizations: 
Object

Optional. Ultravox request authorizations. See the documentation of the specified endpoint for details.

body

Copy URL
body: 
Object

Optional. Ultravox request body. See the documentation of the specified endpoint for details.

endpoint

Copy URL
endpoint: 
HTTPEndpoint

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.

onWebSocketClose

Copy URL
onWebSocketClose: 
(event: WebSocketEvents.CLOSE) => void
 | 
undefined

Optional. A callback function that is called when the WebSocket connection is closed.

pathParameters

Copy URL
pathParameters: 
Object

Optional. Ultravox request path parameters. See the documentation of the specified endpoint for details.

queryParameters

Copy URL
queryParameters: 
Object

Optional. Ultravox request query parameters. See the documentation of the specified endpoint for details.