Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.58 KB

CallPlaybackEndedPayload.md

File metadata and controls

35 lines (23 loc) · 1.58 KB

CallPlaybackEndedPayload

Properties

Name Type Description Notes
callControlId String Call ID used to issue commands via Call Control API. [optional]
connectionId String Call Control App ID (formerly Telnyx connection ID) used in the call. [optional]
callLegId String ID that is unique to the call and can be used to correlate webhook events. [optional]
callSessionId String ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. [optional]
clientState String State received from a command. [optional]
mediaUrl String The audio URL being played back, if audio_url has been used to start. [optional]
mediaName String The name of the audio media file being played back, if media_name has been used to start. [optional]
overlay Boolean Whether the stopped audio was in overlay mode or not. [optional]
status StatusEnum Reflects how command ended. [optional]

Enum: StatusEnum

Name Value
FILE_NOT_FOUND "file_not_found"
CALL_HANGUP "call_hangup"
UNKNOWN "unknown"
FAILED "failed"
CANCELLED_AMD "cancelled_amd"
COMPLETED "completed"
FAILED2 "failed"