Legs API
...
Leg Actions
Leg Actions — External Events
23 min
introduction this page lists all external events emitted by leg actions events are delivered asynchronously to the configured leg event endpoint answer event name event type description leg answered leg action event triggered when the leg is successfully answered answer failed leg action event triggered when the answer action fails hangup event name event type description leg terminated leg lifecycle event triggered when the leg is terminated hangup failed leg action event triggered when hangup fails dial event name event type description dial initiated leg action event triggered when dial action starts dial success leg action event triggered when dial is successful dial completed leg action event triggered when dial flow completes dial failed leg action event triggered when dial fails startplay event name event type description play started leg action event triggered when playback starts play completed leg action event triggered when playback completes play interrupted leg action event triggered when playback is interrupted play failed to start leg action event triggered when playback fails to start stopplay event name event type description play interrupted leg action event triggered when playback is stopped play failed to stop leg action event triggered when playback fails to stop startsay (say) event name event type description say started leg action event triggered when tts starts say completed leg action event triggered when tts completes say interrupted leg action event triggered when tts is interrupted say failed to start leg action event triggered when tts fails to start stopsay event name event type description say interrupted leg action event triggered when tts is stopped say failed to stop leg action event triggered when stopping tts fails gather event name event type description gather initiated leg action event triggered when gather is initiated gather started leg action event triggered when digit collection starts gather success leg action event triggered when digits are successfully collected gather failed leg action event triggered when gather fails gather interrupted leg action event triggered when gather is interrupted senddigits event name event type description digits sent leg action event triggered when dtmf digits are sent digits failed to send leg action event triggered when dtmf sending fails startrecording event name event type description recording started leg action event triggered when recording starts recording stopped leg action event triggered when recording stops recording failed to start leg action event triggered when recording fails to start recording available leg action event triggered when recording file is available stoprecording event name event type description recording stopped leg action event triggered when recording stops recording failed to stop leg action event triggered when stopping recording fails recording available leg action event triggered when recording file is available hold event name event type description hold success leg action event triggered when leg is placed on hold hold failed leg action event triggered when hold fails unhold event name event type description unhold success leg action event triggered when leg is resumed unhold failed leg action event triggered when resume fails mute event name event type description mute success leg action event triggered when audio is muted mute failed leg action event triggered when mute fails unmute event name event type description unmute success leg action event triggered when audio is unmuted unmute failed leg action event triggered when unmute fails joinbridge event name event type description leg joined bridge leg action event triggered when leg joins the bridge leg failed to join bridge leg action event triggered when joining bridge fails leavebridge event name event type description leg left bridge leg action event triggered when leg leaves the bridge leg failed to leave bridge leg action event triggered when leaving bridge fails startmonitoring event name event type description monitoring initiated leg action event triggered when monitoring is initiated monitoring started leg action event triggered when monitoring starts monitoring failed leg action event triggered when monitoring fails stopmonitoring event name event type description monitoring stopped leg action event triggered when monitoring stops monitoring failed to stop leg action event triggered when stopping monitoring fails referred leg action event triggered when control is transferred startstream event name event type description stream initiated leg action event triggered when streaming is initiated stream started leg action event triggered when streaming starts stream stopped leg action event triggered when streaming stops stream failed leg action event triggered when streaming fails stopstream event name event type description stream stopped leg action event triggered when streaming stops stream failed to stop leg action event triggered when stopping stream fails referred leg action event triggered when control is transferred refer event name event type description referred leg action event triggered when event endpoint is updated notes for developers events are asynchronous receipt of a 202 accepted response does not guarantee success always rely on external events to determine action outcome
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.
