Top Message

Sicherheit

Wenn Sie Webhook-Endpunkte einrichten, können Sie Ihre Anwendung vor unerwünschten Anfragen schützen, indem Sie das Webhook-Geheimnis konfigurieren. Jede Anfragesignatur wird mit dem Hashing-Algorithmus HMAC_SHA256 erstellt. Der Algorithmus signiert die Webhook-Nutzlast mit dem von Ihnen angegebenen Geheimnis. Der resultierende Hash ist im Signaturheader der Anfrage im folgenden Format enthalten:

X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Verwalten Sie Ihre Webhook-Endpunkte

hier

Anwendungsbeispiele

Nachfolgend sind einige Anwendungsbeispiele für die TopMessage-API aufgeführt:

Vollständige Anforderungsparameter

NameTypBeschreibung
dataobject
Enthält Nachrichteninformationen.
Data Object
NameTypBeschreibung
idstring
Eindeutige Kennung Ihrer Nachricht.
request_idstring
Eindeutige Kennung der von Ihnen generierten Anfrage zum Verfolgen von Anfragen.
Standard: NULL
channelstring
Der Kommunikationskanal, über den Ihre Nachricht gesendet wurde.
Möglichen Werte: SMS und WHATSAPP
statusstring
Anfangsstatus Ihrer Nachricht.
Möglichen Werte: PENDING, FAILED, DELIVERED, SEEN
typestring
Art des Ereignisses im Zusammenhang mit der Nachricht.
POST
https://{Ihre_Domain}/Ihr_webhook/pfad
X-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/json
Anfragebeispiel

Payload

Java

Python

PHP

Node.js

C#

{
    "data": {
        "id": "b04fc4d3-f232-46b7-b66b-538c0d4b3404",
        "request_id": "b04fc4d3-f232-46b7-b66b-538c0d4b3404",
        "channel": "SMS",
        "status": "DELIVERED",
        "type": "STATUS"
    }
}
Antwortbeispiel
200 OK