SMS E-Mail Parsing Erfolgreich

POST

Wird ausgelöst, wenn E-Mail zu SMS erfolgreich geparst wird

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.email.parsing.success

data

Data for sms.email.parsing.success events

object

sms

Array of SMS data from parsed email

Array<object>

object

uuid

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}$/

text

Der Nachrichtentext kann eine Länge von maximal 1530 Zeichen im GSM Standardzeichensatz enthalten. Mit einer Unicode SMS liegt die maximale Zeichenlänge bei 670 Zeichen. Das interne Encoding ist in beiden Fällen UTF-8.

string

email

Email object for bulk email events

object

id

Email identifier

string

from

Sender email address

string format: email

to

Destination email address

string format: email

subject

Email subject line

string

body

Email body content

string

Examples

Example success

SMS Email Parsing Success Event

Event sent when email to SMS parsing is successful

{
  "id": "d6ff9b42-1da5-711f-df20-f0173a4e7df1",
  "api_version": "2022-05-25",
  "name": "sms.email.parsing.success",
  "created_at": 1653378803,
  "attempt_total": 1,
  "attempt_number": 1,
  "data": {
    "sms": [
      {
        "uuid": "f8a34ce6-ee9f-33ae-d8fc-747622ddd9fe",
        "to": "+4915123456789",
        "text": "Hello, this is your SMS message content parsed from email."
      }
    ],
    "email": {
      "id": "email-456",
      "from": "sender@example.com",
      "to": "sms@your-domain.com",
      "subject": "SMS Request",
      "body": "Send SMS to +4915123456789: Hello, this is your SMS message content parsed from email."
    }
  },
  "notification_task_id": "5590fa05-fb88-6fc0-bf3b-4d32f63dd863"
}

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