Inbound call started

webhook

v2.call.inbound.started

An inbound call has started. An inbound call is a call to a Callr hosted phone number.

Example

{
  "id": "a0331744032570765801hT3kQwPzX9aB",
  "at": "2025-04-07T13:29:30.765Z",
  "sid": "k3v9xq2m",
  "type": "v2.call.inbound.started",
  "try": 0,
  "payload": {
    "direction": "inbound",
    "callid": 240711945874,
    "callerName": "John Doe",
    "callerNumber": "+33639983040",
    "callerRestricted": false,
    "callee": "+33199001030",
    "started": "2025-04-07T13:29:30.512Z",
    "billingDestinationLabel": "France - Geographic",
    "billingPaymentType": "prepaid",
    "scenarioSid": "q5t9mw2e",
    "scenarioName": "My Call Flow",
    "scenarioTypeName": "Actions",
    "scenarioTypeVersion": "1.0"
  }
}

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

Response

2XX