Über diesen Endpunkt können Sie Webhooks erstellen, einsehen und löschen.
Bitte richten Sie den Request an folgende URL:
https://gateway.sms77.io/api/hooks
Parameter | Beschreibung | Beispiele |
---|---|---|
action | Die Aktion, die ausgeführt werden soll | read – Listet alle aktiven Webhooks aufsubscribe – Einen Webhook erstellenunsubscribe – Einen Webhook löschen |
Parameter | Beschreibung | Beispiele |
---|---|---|
target_url | Zieladresse Ihres Webhooks | https://ihre-domain.de/webhook |
event_type | Art des Events, für dass Sie einen Webhook erhalten möchten | all – Sendet alle Ereignissesms_mo – Neue Inbound SMSdlr – Statusberichte Ihrer SMSvoice_status – Aktualisierungen des Status Voiceanrufen.tracking – Klicks bzw. Views des Performance Tracking |
event_filter | Optional. Sendet den Webhook nur, sofern der Filter zutrifft. Zum Beispiel für unterschiedliche Webhooks bei unterschiedlichen Inboundnummern. | 4915126716517 |
request_method | Requestmethode, in der Sie den Webhook erhalten möchten | POST – Sie erhalten Webhooks als HTTP POST Request als application/x-www-form-urlencoded (Standard)GET – Sie erhalten Webhooks als HTTP GET RequestJSON – Sie erhalten Webhooks per HTTP POST als JSON Payload |
Beispiel
https://gateway.sms77.io/api/hooks?p=IHR_API_KEY&action=subscribe&target_url=https%3A%2F%2Fihre-domain.de%2Fwebhook&event_type=sms_mo&request_method=GET
Sie erhalten im Erfolgsfall folgende Rückgabe:
{
"success": true,
"code": null,
"id": 12345
}
Webhook löschen
Rufen Sie die API mit action=unsubscribe und denselben Parametern auf, mit denen der Webhook erstellt wurde (target_url
, event_type
, request_method
), um diesen wieder zu löschen.
Alternativ können Sie einen Webhook direkt über die jeweilige ID und ohne target_url
, event_type
, request_method
löschen . Geben Sie hierzu den Parameter id
an.
Sie erhalten dieselbe Rückgabe wie beim Erstellen des Webhooks.
Beispiel
https://gateway.sms77.io/api/hooks?p=IHR_API_KEY&action=unsubscribe&id=123
Oder:
https://gateway.sms77.io/api/hooks?p=IHR_API_KEY&action=unsubscribe&target_url=https%3A%2F%2Fihre-domain.de%2Fwebhook&event_type=sms_mo&request_method=GET
Webhooks auslesen
Lesen Sie mit dem Parameter action=read alle aktuellen Webhooks Ihres Accounts aus.
Beispiel
https://gateway.sms77.io/api/hooks?p=IHR_API_KEY&action=read
{
"success": true,
"code": null,
"hooks": [
{
"id": "23",
"target_url": "https:\/\/ihre-domain.de\/webhook",
"event_type": "sms_mo",
"event_filter": null,
"request_method": "POST",
"created": "2020-11-04 13:49:16"
}
]
}
Beispielanfragen
Eingehende SMS (sms_mo)
{
"data": {
"id": "681590",
"sender": "SMS",
"system": "491771783130",
"text": "Hallo, ich bin der Text eines Webhook-Beispiels.",
"time": "1605878104"
},
"webhook_event": "sms_mo",
"webhook_timestamp": "2020-12-02 11:55:44"
}
SMS-Statusänderung (dlr)
{
"data": {
"msg_id": "77149843739",
"status": "TRANSMITTED",
"timestamp": "2021-08-24 08:08:00.000000"
},
"webhook_event": "dlr",
"webhook_timestamp": "2021-08-24T08:08:00+02:00"
}
Sprachnachricht-Statusänderung (voice_status)
{
"data": {
"callerId": "491771783130",
"duration": "4",
"id": "284195",
"pricePerMinute": 0.075,
"recipient": "4943160049851",
"status": "completed",
"timestamp": 1629786769
},
"webhook_event": "voice_status",
"webhook_timestamp": "2021-08-24T08:32:50+02:00",
}
Performance Tracking (tracking)
{
"webhook_event": "tracking",
"webhook_timestamp": "2022-07-27T07:38:18+02:00",
"data": {
"sms_id": "77184244925",
"sms_label": null,
"tracking_url": "https://ul.gl/EUGClu",
"final_url": "https://www.google.de",
"type": "click",
"total_clicks": 1,
"total_views": "0"
}
}