Überblick über die webhook-api: integration und automatisierung

Webhooks

Nutzen Sie Webhooks, um Nachrichtenereignisse sofort in Ihrem System zu empfangen.

Es stehen zwei Webhook-Typen zur Verfügung:

  1. Webhook für den Zustellstatus ausgehender Nachrichten.
  2. Webhook für eingehende Nachrichten über SMS und andere unterstützte Kanäle.

1. Webhook für Zustellstatus

Konfigurieren Sie diesen Webhook in den Geräteeinstellungen, um Statusupdates ohne API-Polling zu erhalten.

{
  "sms_id": int,
  "status_id": int,
  "status_message": string,
  "sendto": string,
  "senttime": datetime,
  "channel_id": int,
  "device_id": int
}
  • 1 - Ausstehende SMS
  • 2 - Vom Telefon übernommene SMS
  • 3 - In der Warteschlange zum Senden. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - Eingehende SMS
  • 6 - Vom Telefon gesendete SMS
  • 7 - SMS wurde zugestellt
  • 8 - SMS wurde NICHT zugestellt
  • 9 - SMS wurde überhaupt nicht gesendet – Generic Failure. (Lesen Sie, was bei diesem Fehler zu tun ist hier)
  • Weitere, seltenere Fehler:
  • 10 - SMS nicht gesendet - No Service
  • 11 - SMS nicht gesendet - Null PDU
  • 12 - SMS nicht gesendet - Radio Off
  • 100, 101 - SMS nicht gesendet - NOT ALLOWED. (Der Anwendung wurden keine Berechtigungen zum Senden von SMS erteilt)

2. Webhook für eingehende Nachrichten

Konfigurieren Sie diesen Webhook, um eingehende Nachrichten an Ihr CRM, Helpdesk oder Backend weiterzuleiten.

Das Payload enthält ein Feld „type“, das angibt, ob die eingehende Nachricht eine Textnachricht oder ein Bild ist (z. B. aus WhatsApp).

Textnachricht (type = „text“)

Wird für eingehende SMS und eingehende Textnachrichten aus WhatsApp / WhatsApp Business / RCS gesendet.

{
  "address": string,
  "date": datetime,
  "date_sent": datetime,
  "body": string,
  "internal_id": int,
  "channel_id": int,
  "sms_id": int,
  "device_id": int,
  "device_name": string,
  "type": "text"
}

Bildnachricht (type = „img“)

Wird für eingehende Bilder aus WhatsApp / WhatsApp Business gesendet. Das Bild ist bereits in unseren S3-Speicher hochgeladen – Ihr Backend muss nur die URL speichern und die Datei nicht herunterladen und erneut hochladen.

{
  "address": string,
  "date": datetime,
  "date_sent": datetime,
  "body": "",
  "internal_id": null,
  "sim": int,
  "sms_id": int,
  "type": "img",
  "img_url": "https://smsgateway24.s3.eu-central-1.amazonaws.com/..."
}

Hinweise:

  • „img_url“ ist ein dauerhafter öffentlicher Link zu dem in unserem S3-Bucket gespeicherten Bild.
  • Bei Bildnachrichten ist „body“ leer und „internal_id“ null – verwenden Sie „sms_id“ als eindeutige Kennung.
  • Die Webhook-URL stammt aus derselben Kanal-Slot-Einstellung wie bei Textnachrichten (WhatsApp = Slot 3, WhatsApp Business = Slot 2).
Die Verfügbarkeit von Webhooks hängt von Ihrem Abotarif ab.