Zum Inhalt springen

Telefon-Anmeldung Webhook

POST

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

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.subscribe
data

Phone subscribe webhook data payload

object
phone
required

Telefonnummer, die sich angemeldet hat

string
user_id
required

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

integer
created_at
required

Unix timestamp when the subscribe occurred

integer
campaign_code
required

Kampagnencode, der mit der Anmeldung verknüpft ist

string
additional_data
required

Zusätzliche Daten zum Anmeldeereignis

Array<object>
object
short_link_code
required

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

string
group_id
required

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

integer
timestamp

Unix-Zeitstempel, wann die Anmeldung erfolgte

Examples
Example subscribe

Telefon-Anmeldeereignis

{
"id": "ed18a290-766d-46cf-ab4e-6fa421405fbd",
"data": {
"phone": "+99559122567",
"user_id": 21911,
"created_at": 1757926648,
"campaign_code": "1dkGdCC2xnBc",
"additional_data": [],
"short_link_code": "baaIoP",
"group_id": 123
},
"name": "phone.subscribe",
"created_at": 1757926648,
"api_version": "2022-05-25",
"attempt_number": 1,
"attempts_total": 4
}

Webhook empfangen

Ungültige Struktur der Webhook-Anfrage

Webhook-Anfrage nicht autorisiert

Webhook-Zugang untersagt

Webhook-Zugang untersagt

Server-Fehler