SMS Zustellbericht (DLR)

POST

Das Ereignis ‘sms.delivery’ sendet bei Änderungen des dlr_code. So können Sie feststellen, ob eine SMS erfolgreich zugestellt wurde, abgelehnt wurde oder noch zugestellt wird.

Jede übermittelte SMS hat einen Zustellungsbericht-Code Webhook-Ereignisbenachrichtigungen

Authorizations

• token

Request Body ^required

Media type application/json

object

id

Eindeutige Entitäts-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 der Datenstruktur der Meldung

string

name

Name des Webhook-Ereignisses

string

created_at

Zeitstempel, wann die Entität vom Benutzer zum System hinzugefügt wurde

integer

attempt_total

Gesamtzahl der Zustellversuche von Benachrichtigungs-Webhooks

integer

>= 1 <= 4

attempt_number

Aktuelle Nummer des Webhook-Benachrichtigungsversuchs

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: sms.delivery

data

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

object

id

Eindeutige Entitäts-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-Schlüssel-Kennung

integer

>= 1

dlr_code

Zustellbericht der SMS

integer

Allowed values: 0 1 2 4 8 16

status_code

Status der SMS, für mehr Informationen: SMS status codes

integer

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

callback_data

Wert (String) welcher an Ihren Endpoint zurückgeschickt wird. Sie können z.B. Ihre eigene ID so übergeben und mit dem Zustellbericht (DLR) zurückbekommen.

string | null

<= 36 characters

Examples

SMS-Zustellereignis

Ereignis gesendet wenn sich der SMS-Zustellstatus ändert

{
  "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8",
  "api_version": "2022-05-25",
  "name": "sms.delivery",
  "created_at": 1653378603,
  "attempt_total": 4,
  "attempt_number": 1,
  "data": {
    "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc",
    "key_id": 8207,
    "dlr_code": 1,
    "status_code": 100,
    "callback_data": "some data from user's request here"
  },
  "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641"
}

SMS-Zustellung abgelaufenes Ereignis

Ereignis gesendet wenn die SMS-Zustellung abläuft

{
  "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8",
  "api_version": "2022-05-25",
  "name": "sms.delivery",
  "created_at": 1653378603,
  "attempt_total": 4,
  "attempt_number": 1,
  "data": {
    "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc",
    "key_id": 8207,
    "dlr_code": 8,
    "status_code": 100,
    "callback_data": "order-12345"
  },
  "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641"
}

Responses

200

Webhook empfangen

400

Ungültige Struktur der Webhook-Anfrage

401

Webhook-Anfrage nicht autorisiert

403

Webhook-Zugang untersagt

404

Webhook-Zugang untersagt

500

Server-Fehler