Skip to main content

SipHeaderCaptureSession

idstring<uuid>required
phoneNumberIdstring<uuid>required
statusstringrequired

Possible values: [waiting, captured]

startedAtstring<date-time>required
expiresAtstring<date-time>required
capturedAt(string | null)<date-time>nullablerequired
firstLinestring | nullnullablerequired
callIdstring | nullnullablerequired
sourceIpstring | nullnullablerequired
headers object[]required
  • Array [
  • namestringrequired
    valuestringrequired

    Exact unredacted value received after the SIP header colon, including leading whitespace and folded continuation lines.

    indexintegerrequired

    Possible values: >= 0

  • ]
  • SipHeaderCaptureSession
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "phoneNumberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "waiting",
    "startedAt": "2024-07-29T15:51:28.071Z",
    "expiresAt": "2024-07-29T15:51:28.071Z",
    "capturedAt": "2024-07-29T15:51:28.071Z",
    "firstLine": "string",
    "callId": "string",
    "sourceIp": "string",
    "headers": [
    {
    "name": "string",
    "value": "string",
    "index": 0
    }
    ]
    }