Top Message

Beveiliging

Bij het instellen van webhook-eindpunten kunt u uw applicatie beveiligen tegen ongewenste verzoeken door webhook-geheim te configureren. Elke verzoekhandtekening wordt gemaakt met behulp van het HMAC_SHA256 hash-algoritme. Het algoritme ondertekent de webhook-payload met het geheim dat u heeft opgegeven. De resulterende hash wordt opgenomen in de handtekeningheader van het verzoek in de volgende indeling:

X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Beheer uw webhookeindpunten

hier

Gebruiksvoorbeelden

Hieronder volgen enkele voorbeelden van use cases voor de TopMessage API:

Volledige aanvraagparameters

NaamVriendelijkBeschrijving
dataobject
Bevat berichtinformatie.
Data Object
NaamVriendelijkBeschrijving
idstring
Unieke identificatie van uw bericht.
request_idstring
Unieke identificatie van het verzoek dat door u wordt gegenereerd om verzoeken te traceren.
Standaard: NULL
channelstring
Het communicatiekanaal stuurt uw boodschap door.
Mogelijke waarden: SMS En WHATSAPP
statusstring
Initiële status van uw bericht.
Mogelijke waarden: PENDING, FAILED, DELIVERED, SEEN
typestring
Type gebeurtenis gekoppeld aan het bericht.
POST
https://{uw_domein}/uw_webhook/pad
X-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/json
Monster aanvragen

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"
    }
}
Reactievoorbeeld
200 OK