Top Message

Sicurezza

Quando configuri gli endpoint webhook, puoi proteggere la tua applicazione da richieste indesiderate configurando il segreto del webhook. Ogni firma di richiesta viene creata utilizzando l'algoritmo di hashing HMAC_SHA256. L'algoritmo firma il payload del webhook con il segreto che hai fornito. L'hash risultante è incluso nell'intestazione della firma della richiesta nel seguente formato:

X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Gestisci i tuoi endpoint webhook

qui

Esempi di casi d'uso

Di seguito sono riportati alcuni esempi di casi d'uso per l'API TopMessage:

Parametri di richiesta completi

NomeTipoDescrizione
dataobject
Contiene informazioni sul messaggio.
Data Object
NomeTipoDescrizione
idstring
Identificatore univoco del tuo messaggio.
request_idstring
Identificatore univoco della richiesta da te generato per tracciare le richieste.
Predefinito: NULL
channelstring
Il canale di comunicazione invia il tuo messaggio.
Valori possibili: SMS E WHATSAPP
statusstring
Stato iniziale del tuo messaggio.
Valori possibili: PENDING, FAILED, DELIVERED, SEEN
typestring
Tipo di evento collegato al messaggio.
POST
https://{tuo_dominio}/tuo_webhook/percorso
X-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/json
Richiedi campione

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"
    }
}
Esempio di risposta
200 OK