Leg Actions — External Events
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