Skip to main content
WEBHOOK
callHangup
{
  "data": {
    "record_type": "event",
    "event_type": "call.hangup",
    "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "occurred_at": "2018-02-02T22:25:27.521992Z",
    "payload": {
      "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
      "connection_id": "7267xxxxxxxxxxxxxx",
      "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
      "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
      "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
      "from": "+35319605860",
      "to": "+35319605860",
      "start_time": "2018-02-02T22:20:27.521992Z",
      "state": "hangup",
      "hangup_cause": "call_rejected",
      "hangup_source": "caller",
      "sip_hangup_cause": "603",
      "call_quality_stats": {
        "inbound": {
          "jitter_max_variance": "2.74",
          "jitter_packet_count": "0",
          "mos": "4.50",
          "packet_count": "591",
          "skip_packet_count": "9"
        },
        "outbound": {
          "packet_count": "0",
          "skip_packet_count": "0"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
telnyx-timestamp
integer<int64>
required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

​
telnyx-signature-ed25519
string
required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/json
​
data
Call Hangup · object
Example:
{
  "record_type": "event",
  "event_type": "call.hangup",
  "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "occurred_at": "2018-02-02T22:25:27.521992Z",
  "payload": {
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "from": "+35319605860",
    "to": "+35319605860",
    "start_time": "2018-02-02T22:20:27.521992Z",
    "state": "hangup",
    "hangup_cause": "call_rejected",
    "hangup_source": "caller",
    "sip_hangup_cause": "603",
    "call_quality_stats": {
      "inbound": {
        "jitter_max_variance": "2.74",
        "jitter_packet_count": "0",
        "mos": "4.50",
        "packet_count": "591",
        "skip_packet_count": "9"
      },
      "outbound": {
        "packet_count": "0",
        "skip_packet_count": "0"
      }
    }
  }
}

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.