Ein Webhook (oder Callback) ermöglicht es unserer Plattform, Ihre Anwendung mit Informationen über ein bestimmtes Ereignis (z. B. eine neu eingegangene SMS) anzupingen. Dies geschieht in Echtzeit, so dass Sie die Plattform nutzen können, um Ihre eigenen 2-Wege-Nachrichtenlösungen zu erstellen, indem Sie SMS über die API senden und alle Antworten über Webhooks verarbeiten.
Häufige Ereignisse, die Sie sich anhören sollten:
- SMS -> Empfang von SMS
- SMS -> Erfolgte Abmeldungen
- Zustellungsberichte -> Nachricht ist zugestellt
- Zustellungsberichte -> Nachricht ist abgelaufen
Um einen Webhook zu erstellen, navigieren Sie zu Einstellungen > API und wählen Sie die Registerkarte Webhooks, dann klicken Sie auf Neuer Webhook:
Richten Sie die Grundlagen für Ihren Webhook ein:
- Wählen Sie das/die Ereignis(e) aus, auf das/die Sie hören möchten (z. B. SMS -> SMS-Empfang)
- Wählen Sie die HTTP-Methode, die wir an Ihre Anwendung senden sollen (z. B. POST)
- Geben Sie die URL ein, unter der Sie das Ereignis verarbeiten möchten (z. B. https://ihreapp.com/sms/eingehende-sms)
Als Nächstes geben Sie alle Kopfzeilen an, die Sie in Ihrer Anfrage anzeigen möchten. Um weitere Kopfzeilen hinzuzufügen, klicken Sie einfach auf Kopfzeile hinzufügen:
Geben Sie anschließend den Inhalt an, der im Inhalt der Anfrage an den angegebenen Endpunkt übergeben werden soll.
Eine gute Voreinstellung wäre die folgende:
|
id |
$mtID |
|
accountId |
$accountId |
|
sourceAddress |
$sourceAddress |
|
destinationAddress |
$DestinationAddress |
|
messageContent |
$mtContent |
|
replyContent |
$moContent |
Klicken Sie abschließend unten rechts auf dem Bildschirm auf Webhook speichern.
In diesem Beispiel haben wir einen Webhook erstellt, der beim Empfang einer SMS eine JSON-Anfrage mit den folgenden Informationen im JSON-Body an https://ihreapp.com/sms/eingehende-sms sendet: id, accountId, sourceAddress, destinationAddress, messageContent, replyContent.