Eingehende Inbound SMS

POST

Das Ereignis ‘sms.incoming’ wird bei einer eingehenden/beantwortenden SMS (mobile originated - SMS-MO - Inbound SMS) gesendet.

Webhook-Benachrichtigungen

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.incoming

data

Data for sms.incoming 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}$/

to

Zielrufnummer:

• +491701234567 (E.164)
• 00491701234567
• 491701234567
• 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567

Wenn Sie Ihre Rufnummer nicht im E.164 Format übertragen, versucht unser System die Rufnummer anhand Ihres Firmensitzes aus Ihren Profildaten in E.164 Format zu konvertieren. Um Probleme bei der automatischen Konvertierung zu vermeiden, nutzen Sie bitte bevorzugt das E.164 Format.

string

>= 7 characters <= 16 characters /^\+[1-9]\d{1,14}$/

from

Zielrufnummer:

• +491701234567 (E.164)
• 00491701234567
• 491701234567
• 01701234567 (wenn Ihr Account in Deutschland registriert ist) wird es konvertiert zu +491701234567

Wenn Sie Ihre Rufnummer nicht im E.164 Format übertragen, versucht unser System die Rufnummer anhand Ihres Firmensitzes aus Ihren Profildaten in E.164 Format zu konvertieren. Um Probleme bei der automatischen Konvertierung zu vermeiden, nutzen Sie bitte bevorzugt das E.164 Format.

string

>= 7 characters <= 16 characters /^\+[1-9]\d{1,14}$/

received_at

Unix Timestamp des SMS Empfangs

integer

text

SMS Text

string | null

msg_uuid

ID der SMS auf welche geantwortet wurde

string | null

Examples

Example reply

SMS-Eingangs-Ereignis

Ereignis gesendet wenn eine eingehende SMS empfangen wird

{
  "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1",
  "api_version": "2022-05-25",
  "name": "sms.incoming",
  "created_at": 1653378703,
  "attempt_total": 1,
  "attempt_number": 1,
  "data": {
    "id": "e7d23bd5-dd8e-22fd-c7eb-636511ccc8ed",
    "to": "+1234567890",
    "from": "+490987654321",
    "text": "Hello, this is a reply message",
    "received_at": 1653378703,
    "msg_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "notification_task_id": "4489ef94-ef77-5ef9-ae2a-3c21e52cc752"
}

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