| 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] |
| from | String | Number or SIP URI placing the call. | [optional] |
| to | String | Destination number or SIP URI of the call. | [optional] |
| startTime | OffsetDateTime | ISO 8601 datetime of when the call started. | [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] |
| Name | Value |
|---|---|
| HANGUP | "hangup" |
| 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" |
| Name | Value |
|---|---|
| CALLER | "caller" |
| CALLEE | "callee" |
| UNKNOWN | "unknown" |