Telefon-Abmeldung Webhook

POST

Wird ausgelöst, wenn sich eine Telefonnummer durch das Absenden eines Formulars abmeldet

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: phone.unsubscribe

data

Phone unsubscribe webhook data payload

object

phone

required

Telefonnummer, die sich abgemeldet hat

string

user_id

required

ID des Benutzers, der mit der Telefonnummer verknüpft ist

integer

created_at

required

Unix timestamp when the unsubscribe occurred

integer

campaign_code

required

Kampagnencode, der mit der Abmeldung verknüpft ist

string

additional_data

required

object

reason

required

object

id

required

Grund-ID für die Abmeldung. Mögliche Werte:

• 1: Ich habe mich nie angemeldet
• 2: Es sind zu viele Nachrichten
• 3: Es interessiert mich nicht
• 4: Es ist unverständlich
• 5: Ich mag Ihr Unternehmen nicht
• 6: Anderer Grund

integer

Allowed values: 1 2 3 4 5 6

label

required

Menschenlesbarer Grund für die Abmeldung

string

additional_text

required

Zusätzlicher Text, der vom Benutzer bereitgestellt wurde

string

short_link_code

required

Kurz-Link-Code, der mit der Abmeldung verknüpft ist

string

unsubscribe_request_id

required

ID der Abmeldeanfrage

integer

group_id

ID der Gruppe, die mit der Telefon-Abmeldung verknüpft ist

integer

timestamp

Unix-Zeitstempel, wann die Abmeldung erfolgte

Examples

Example unsubscribe

Telefon-Abmeldeereignis

{
  "id": "ef58b437-1319-4b0c-961b-17214cf1cf32",
  "data": {
    "phone": "+4911113333444",
    "user_id": 2,
    "created_at": 1757849748,
    "campaign_code": "3KCKb5nMD",
    "additional_data": {
      "reason": {
        "id": 4,
        "label": "Es ist unverständlich"
      },
      "additional_text": "zusätzlicher Benutzertext mit Erklärung"
    },
    "short_link_code": "baaIou",
    "unsubscribe_request_id": 59
  },
  "name": "phone.unsubscribe",
  "created_at": 1757849748,
  "api_version": "2022-05-25",
  "attempt_number": 1,
  "attempts_total": 4
}

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