Skip to content

Latest commit

 

History

History
43 lines (39 loc) · 2.18 KB

CallHangupPayload.md

File metadata and controls

43 lines (39 loc) · 2.18 KB

CallHangupPayload

Properties

Name Type Description Notes
callControlId UUID Call ID used to issue commands via Call Control API. [optional]
connectionId String 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. [optional]
clientState String State received from a command. [optional]
from String Number or SIP URI placing the call. [optional]
to String Destination number or SIP URI of the call. [optional]
state StateEnum State received from a command. [optional]
hangupCause HangupCauseEnum The reason the call was ended (`call_rejected`, `normal_clearing`, `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or `unspecified`). [optional]
hangupSource HangupSourceEnum The party who ended the call (`callee`, `caller`, `unknown`). [optional]
sipHangupCause String The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to `unspecified`. [optional]

Enum: StateEnum

Name Value
HANGUP "hangup"

Enum: HangupCauseEnum

Name Value
CALL_REJECTED "call_rejected"
NORMAL_CLEARING "normal_clearing"
ORIGINATOR_CANCEL "originator_cancel"
TIMEOUT "timeout"
TIME_LIMIT "time_limit"
USER_BUSY "user_busy"
NOT_FOUND "not_found"
UNSPECIFIED "unspecified"

Enum: HangupSourceEnum

Name Value
CALLER "caller"
CALLEE "callee"
UNKNOWN "unknown"