Dryrun SMS delivery report (DLR)

POST

The event ‘sms.delivery.dryrun’ uses per an emulation SMS send. See Simulate sending an SMS (for testing).

Each SMS has delivery report code (DLR).

Webhook notifications

Authorizations

• token

Request Body ^required

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Version of the notification webhook data structure

string

Example

2022-05-25

name

Webhook’s event name

string

created_at

Timestamp when the entity was added to the system by the user

integer

attempt_total

Total number of notification webhook delivery attempts

integer

>= 1 <= 4

Example

4

attempt_number

Current webhook notification attempt number

integer

>= 1

Example

1

data

Event-specific data payload

object

notification_task_id

Notification task identifier (request identifier)

string format: uuid

Example

3378de83-de66-4de8-9d29-2b10d41bb641

name

Allowed values: sms.delivery.dryrun

data

Data for sms.delivery and sms.delivery.dryrun events

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

key_id

API key identifier

integer

>= 1

dlr_code

Status of the SMS delivery from gateway

integer

Allowed values: 0 1 2 4 8 16

Example

1

status_code

Status of the sms. For more info see SMS status codes

integer

Allowed values: 0 100 208 400 410 2000 3000 5000 6000

callback_data

String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.

string | null

<= 36 characters

Responses

200

Webhook received

400

Invalid webhook request’s body structure

401

Webhook request unauthorized

403

Webhook access forbidden

404

Webhook access forbidden

500

Server error