Säkerhet
När du ställer in webhook-slutpunkter kan du säkra din applikation mot oönskade förfrågningar genom att konfigurera webhook secret. Varje begäransignatur skapas med hjälp av hashalgoritmen HMAC_SHA256. Algoritmen signerar webhook-nyttolasten med hemligheten du har tillhandahållit. Den resulterande hashen ingår i begärans signaturhuvud i följande format:
X-TopMessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}Hantera dina webhook-slutpunkter
här
Användningsexempel
Följande är några exempel på användningsfall för TopMessage API:
Fullständiga förfrågningsparametrar
| Namn | Slag | Beskrivning |
|---|---|---|
| data | object | Innehåller meddelandeinformation. |
Data Object
| Namn | Slag | Beskrivning |
|---|---|---|
| id | string | Unik identifierare för ditt meddelande. |
| request_id | string | Unik identifierare för begäran som genererats av dig för att spåra förfrågningar. Standard: NULL |
| channel | string | Kommunikationskanalen skickar ditt budskap igenom. Möjliga värden: SMS och WHATSAPP |
| status | string | Initial status för ditt meddelande. Möjliga värden: PENDING, FAILED, DELIVERED, SEEN |
| type | string | Typ av händelse kopplad till meddelandet. |
POST
https://{ditt_doman}/din_webhook/sökvägX-Topmessage-Signature: {TOPMESSAGE_HMAC_SIGNATURE}
Content-Type: application/jsonBegär prov
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"
}
}Svarsprov
200 OK