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
        • Modules
        • AppEvents
        • TerminationStatus
  • 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
VoxEngineRuntime and modules

AppEvents

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

Modules

Next

TerminationStatus

Built with

Values

CallAlerting
'Application.CallAlerting'

Triggered when an incoming call arrives.

Terminating
'Application.Terminating'

Triggered when a session is about to terminate. Triggers in two cases:

  1. when there are no calls and/or ACD requests in a call session. See the session limits for details;
  2. when the VoxEngine.terminate(/docs/references/voxengine/voxengine/terminate) method is called. Timers and any other external resources are not available after this event is triggered, but you can perform one HTTP request inside the event handler (e.g. to notify an external system about the fact that the session is finished). When that request is finished (or no such request is made), the AppEvents.Terminated event is triggered.
Terminated
'Application.Terminated'

Triggered when a session is terminated and after the AppEvents.Terminating event is triggered. The time between these events depends on handler for AppEvents.Terminating event. Use the event just for debugging, only the Logger.write method could be used in a handler.

Started
'Application.Started'

The very first event is triggered due to incoming call or HTTP request to Voximplant cloud over the internet. Triggers only once in a session, so if you execute the same HTTP request again it creates the new, separate session. Note that usage of the event in your JS scenario is optional.

HttpRequest
'Application.HttpRequest'

Triggered when the Management API request is received by the session.

If you start a call session with the HTTP request, you get an answer: an object with media_session_access_url property. The property’s value is the managing URL for the specified session, so it can be used in managing HTTP request that triggers AppEvents.HttpRequest event.

You can find more information in the Remote session management article.

WebSocket
'AppEvents.NewWebSocketConnection'

Triggered when there is a new connection to a WebSocket.

NewWebSocketFailed
'Application.OnNewWebSocketFailed'

Triggered when a WebSocket fails. It can happen when the number of incoming WebSocket connections exceeds the number of calls in one session + 3.