Webhooks
Empfangen Sie Echtzeitrückrufe zu Updates in Smstools.
Was sind Webhooks?
Webhooks sind eine Erweiterung einer API, aber anstatt dass Ihr Code Daten von Smstools anfordert, sendet Smstools Daten an Sie. Die Daten kommen in einer Webanfrage bei Ihrer Anwendung an. Webhooks werden auch verwendet, um Ihre Anwendung über Ereignisse wie einen eingehenden Anruf oder eine Nachricht zu benachrichtigen. Da die Smstools-Server in der Lage sein müssen, Daten an Ihre Anwendung über Webhooks zu senden, müssen Sie einen Webserver einrichten, um die eingehenden HTTP-Anfragen zu empfangen. Sie müssen auch die URL jedes Webhooks auf Ihrem Webserver angeben, damit Daten an jedes gesendet werden können.
Übersicht verfügbarer Webhooks
| Typ | Beschreibung |
|---|---|
| delivery_report | Bericht über die Zustellung nach jeder gesendeten Nachricht. Manchmal können zwei Webhooks vorhanden sein: zunächst ein 'eingereichter' Status und später ein 'zugestellter' oder 'nicht zugestellter' Status. Manchmal stehen zusätzliche Details zur Verfügung, wenn die Nachricht nicht zugestellt wurde. |
| read_report | Lesebestätigung nachdem die Nachricht gelesen wurde. Eine Lesebestätigung ist nur für Social Messaging verfügbar oder durch Verwendung des Links 'Eine Lesebestätigung anfordern'. |
| inbox_message | Eingehende Nachricht. Nur verfügbar, wenn Sie Social Messaging oder eine virtuelle Nummer verwenden. |
Zustellungsberichtcodes
| Codes für Zustellungsberichtsdetails | Status | Erklärung |
|---|---|---|
| 0 | SUBMITTED | Diese Nachricht wurde mit dem Operator zugestellt, aber wir haben keinen Zustellungsbericht erhalten. |
| 1 | DELIVERED | Diese Nachricht wurde erfolgreich zugestellt. |
| 2 | NOT DELIVERED | Diese Nachricht wurde nicht zugestellt. Möglicher Grund: Empfänger befindet sich außerhalb des Bereichs des Netzwerks, Netzwerkprobleme, Empfänger im Ausland. |
| 3 | BUFFERED | Diese Nachricht wurde mit dem Operator zugestellt, aber nicht mit dem Empfänger. |
| 4 | REJECTED | Diese Nachricht wurde vom Operator abgelehnt. |
| 5 | REJECTED | Erweiterte Informationen unten! |
| 9 | UNKNOWN | Für diese Nachricht liegen keine Zustellungsberichte vor. |
Codes für Zustellungsberichtsdetails
| Status | Erklärung |
|---|---|
| 10 | Empfängernummer ist ungültig oder unbekannt |
| 11 | Empfänger befindet sich vorübergehend außerhalb des Bereichs des Netzwerkbetreibers |
| 12 | Telefonbezogenes Problem. |
| 13 | Problem mit dem Netzwerk des Betreibers |
| 14 | Nachricht abgelaufen - Grund unbekannt |
| 15 | Empfänger ist auf einer schwarzen Liste verzeichnet |
| 16 | Problem mit dem Nachrichteninhalt |
| 17 | Empfänger kann nicht ermittelt werden |
| 18 | Der Operator hat dies aufgrund von Spam abgelehnt |
| 19 | Abonnent kann keine Premiumnachrichten empfangen (vom Operator blockiert) |
Codes für Zustellungsberichtsdetails bei Antwortcode 5
| Status | Erklärung |
|---|---|
| 2000 | INSUFFICIENT_FUNDS |
| 2001 | TOO_LONG |
| 2002 | TOO_SHORT |
| 2003 | TIMEOUT |
| 2004 | GATEWAY_ISSUES |
| 2005 | INVALID_SENDER |
| 2006 | INVALID_NUMBER |
| 4000 | UNKNOWN |
| 4001 | EMPTY_MESSAGE |
| 4002 | EMPTY_CLIENT |
| 4003 | LOCKED |
| 4004 | BLOCKED |
| 4005 | JOB_FAILED |
| 4006 | DUPLICATE |
| 4007 | INVALID_CONTENT |
Beispiel: Zustellungsbericht
[
{
"webhook_id": "svt1jtrmekgb67ratwa31ptupc",
"webhook_type": "delivery_report",
"username": "myusername",
"message": {
"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
"datetime": "2019-01-01 00:00:00",
"content": "here comes your message body",
"sender": "yoursender",
"receiver": "32470123456",
"reference": "yourref",
"delivery_code": "1", [Possible values: 0,1,2,3,4,9]
"delivery_status": "delivered" [code explanation]
"delivery_code_detail": "10", [delivery code with additional details]
"delivery_code_detail_description": "Unknown Subscriber" [detailed explanation]
}
}
]
Beispiel: eingehende Nachricht
[
{
"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
"webhook_type": "inbox_message",
"username": "myusername",
"message": {
"id": "12345678",
"date": "2019-01-01 00:00:00",
"sender": "sendernumber",
"receiver": "12345678",
"content": "message content",
"type": "sms" [Possible values: sms,whatsapp]
}
"isreply": { [The isreply content will only be added when the message was replied to another message]
"reply": true,
"orig_message_content": "original message content",
"orig_messageid": "985zvqipp73csuuha2079fbshx",
"orig_messagedate": "2019-01-01 00:00:00",
"orig_sender": "32471123456",
"orig_receiver": "12345678",
"orig_reference": ""
}
}
]
Beispiel: Lesebestätigungsbericht
[
{
"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
"webhook_type": "read_report",
"username": "myusername",
"message": {
"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
"datetime": "2019-01-01 00:00:00",
"content": "here comes your message body",
"sender": "yoursender",
"receiver": "32470123456",
"reference": "yourref",
"delivery_code": "1",
"delivery_status": "delivered"
"read_status": "message_read",
"read_datetime": "2019-01-01 00:01:00"
}
}
]