Sécurité
Lors de la configuration des points de terminaison webhook, vous pouvez sécuriser votre application contre les requêtes non désirées en configurant un secret webhook. Chaque signature de requête est générée en utilisant l'algorithme de hachage HMAC_SHA256. L'algorithme signe le payload du webhook avec le secret que vous avez fourni. Le hachage résultant est inclus dans l'en-tête de signature de la requête dans le format suivant :
X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}Gérez vos points de terminaison webhook
ici
Exemples de cas d'utilisation
Voici quelques exemples de cas d'utilisation de l'API TopMessage :
Paramètres complets de la requête
| Nom | Taper | Description |
|---|---|---|
| data | object | Contient des informations sur le message. |
Data Object
| Nom | Taper | Description |
|---|---|---|
| id | string | Identifiant unique de votre message. |
| request_id | string | Identifiant unique de la demande générée par vous pour suivre les requêtes. Par défaut: NULL |
| channel | string | Le canal de communication par lequel votre message est envoyé. Valeurs possibles: SMS et WHATSAPP |
| status | string | Statut initial de votre message. Valeurs possibles: PENDING, FAILED, DELIVERED, SEEN |
| type | string | Type d'événement lié au message. |
POST
https://{votre_domaine}/votre_webhook/cheminX-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/jsonExemple de demande
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"
}
}Exemple de réponse
200 OK