Inbound SMS received

webhook

v2.sms.inbound.received

Example

{
  "id": "a0331744032612006778Vb8NmQw3ErTy",
  "at": "2025-04-07T13:30:12.006Z",
  "sid": "r1x7cm3g",
  "type": "v2.sms.inbound.received",
  "try": 0,
  "payload": {
    "direction": "inbound",
    "sid": "e9k4tz7q",
    "from": "+33639983040",
    "to": "+33639980010",
    "body": {
      "text": "Hello world!"
    },
    "trafficType": "alerting",
    "status": "delivered",
    "created": "2025-04-07T13:30:11Z",
    "delivered": "2025-04-07T13:30:11Z",
    "updated": "2025-04-07T13:30:11Z",
    "parts": 1,
    "network": "20801",
    "encoding": "gsm",
    "cost": "1.00",
    "paymentType": "prepaid"
  }
}

Payload

string

required

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

date-time

required

Timestamp of the event

sid

string

required

length between 8 and 8

^[a-z0-9]{8}$

Unique identifier for the webhook

type

const

enum

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.

Allowed:

try

integer

required

0 to 10

Number of attempts made to deliver the webhook

payload

object

required

SMS

Response

2XX