For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • WebSocket
        • WebSocketAudioEncoding
        • WebSocketCloseCode
        • WebSocketEvents
        • WebSocketReadyState
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Values
VoxEngineWebSocket and protocol integrations

WebSocketEvents

7 values
||View as Markdown|
Was this page helpful?
Edit this page
Previous

WebSocketCloseCode

Next

WebSocketReadyState

Built with

Values

OPEN
'WebSocket.Open'

Triggered when the WebSocket connection is opened. WebSocket.onopen is called right before any other handlers.

CLOSE
'WebSocket.Close'

Triggered when the WebSocket connection is closed. WebSocket.onclose is called right before any other handlers.

MESSAGE
'WebSocket.Message'

Triggered when a message is received by a target object. WebSocket.onmessage is called right before any other handlers.

ERROR
'WebSocket.Error'

Triggers when an error occurs during the WebSocket connection. WebSocket.onerror is called right before any other handlers.

CREATED
'WebSocket.Created'

Triggered when the WebSocket connection is created. WebSocket.oncreated is called right before any other handlers.

MEDIA_STARTED
'WebSocket.MediaEventStarted'

Triggered when the audio stream sent by a third party through a WebSocket is started playing.

MEDIA_ENDED
'WebSocket.MediaEventEnded'

Triggers after the end of the audio stream sent by a third party through a WebSocket (1 second of silence).