Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Inbound SMS received

postWebhookv2.sms.inbound.received

Payload

idstring required

Unique identifier for the event. Use this for idempotency checks.

atstring date-time required

RFC 3339, section 5.6

sidstring required

Short ID

type'v2.sms.inbound.received' required
  • v2.billing.credit.topup = Your account has been credited with a new amount.
  • v2.billing.credit.warning = Your prepaid balance has reached its warning level.
  • v2.billing.credit.shutdown = Your prepaid balance has reached its shutdown level. Your account is suspended.
  • v2.call.inbound.started = An inbound call just started.
  • v2.call.inbound.ended = An inbound call just hung up.
  • v2.call.outbound.started = An outbound call just started.
  • v2.call.outbound.ended = An outbound call just hung up.
  • v2.number.assigned = A phone number was assigned to your account.
  • v2.number.unassigned = A phone number was unassigned from your account.
  • v2.task.updated = A task has been updated.
  • v2.audio-file.updated = An audio file has been updated.
  • v2.recording.updated = A recording has been updated.
  • v2.sms.inbound.received = An inbound SMS has been received.
  • v2.sms.outbound.updated = An outbound SMS has an updated status.
tryinteger required

Number of attempts made to deliver the webhook

Example payload

{
  "id": "a03317440280451052hUD7yPiwWrzgGB",
  "at": "2024-04-24T17:42:28Z",
  "sid": "callrsid",
  "payload": {
    "direction": "inbound",
    "sid": "callrsid",
    "from": "+33199001234",
    "to": "+33199001234",
    "body": {
      "text": "Hello world!"
    },
    "trafficType": "marketing",
    "status": "sent",
    "created": "2024-04-24T17:42:28Z",
    "delivered": "2024-04-24T17:42:28Z",
    "updated": "2024-04-24T17:42:28Z",
    "sent": "2024-04-24T17:42:28Z",
    "parts": 10,
    "network": "20801",
    "encoding": "gsm",
    "cost": "5.50",
    "paymentType": "prepaid",
    "statusHistory": [
      {
        "after": "sent",
        "before": "sent",
        "at": "2024-04-24T17:42:28Z"
      }
    ]
  }
}

Response

OK