Top Message

Seguridad

Al configurar puntos finales de webhook, puede proteger su aplicación contra solicitudes no deseadas configurando el secreto del webhook. Cada firma de solicitud se crea utilizando el algoritmo hash HMAC_SHA256. El algoritmo firma la carga útil del webhook con el secreto que usted proporcionó. El hash resultante se incluye en el encabezado de la firma de la solicitud en el siguiente formato:

X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Administre sus puntos finales de webhook

aquí

Ejemplos de casos de uso

Los siguientes son algunos ejemplos de casos de uso para la API TopMessage:

Parámetros de solicitud completos

NombreAmableDescripción
dataobject
Contiene información del mensaje.
Data Object
NombreAmableDescripción
idstring
Identificador único de su mensaje.
request_idstring
Identificador único de solicitud generada por usted para rastrear solicitudes.
Por defecto: NULL
channelstring
El canal de comunicación envía su mensaje.
Valores posibles: SMS y WHATSAPP
statusstring
Estado inicial de su mensaje.
Valores posibles: PENDING, FAILED, DELIVERED, SEEN
typestring
Tipo de evento relacionado con el mensaje.
POST
https://{tu_dominio}/tu_webhook/ruta
X-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/json
Solicitar muestra

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"
    }
}
Muestra de respuesta
200 OK