Tento webhook vám zasílá informace o odeslaných zprávách. Tento webhook můžete použít k ukládání informací o odeslaných zprávách, jako jsou message_id, gateway, timestamp, payload atd.
JSON API (v2)
API pro odesílání zpráv přes SMS, Viber, WhatsApp a další komunikační kanály.
API klíč je vyžadován pro všechny požadavky. Svůj API klíč naleznete v nastavení účtu.
Verze API (http-api a xml-api) jsou také zastaralé a měli byste místo nich používat toto JSON API v2.
Download OpenAPI description
Overview
URL
E-mail
Languages
Servers
Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/
Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/
Bodyapplication/jsonrequiredArray [
Unikátní identifikátor zprávy. (Pokud použijete endpoint /messages, obdržíte message_id s připojeným -<index_příjemce> k message_id).
Example: "e27ff0ac-87b5-4e1d-b644-5fc6029e2a11"
Použitý flow pro zprávu.
Enum"sms""viber""whatsapp_text""whatsapp_template"
Example: "sms"
Výsledek odeslání zprávy. Nejprve obdržíte stav sent, poté budou následovat další stavy. Pokud je zpráva zamítnuta (rejected), znamená to, že zpráva nebyla ani odeslána (typickým důvodem je nedostatečný kredit nebo neplatné telefonní číslo).
Enum"delivered""undelivered""rejected""failed""sending""sent""seen"
Další kód výsledku pro zprávu ve formátu "[kód] Popis". Kód je volitelný, popis je také volitelný. Informace o výsledku může také obsahovat pouze kód v hranatých závorkách nebo pouze popis bez kódu.
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/sentMessage
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/sentMessage
application/json
[ { "request_id": "bc36f3d1-d284-463a-921b-a3560c154649", "message_id": "e27ff0ac-87b5-4e1d-b644-5fc6029e2a11", "gateway": "sms", "timestamp": 1700000000, "payload": { … }, "type": "outgoing", "to": { … }, "result": "delivered", "result_info": "[0] Delivered" } ]
Bodyapplication/jsonrequiredArray [
Unikátní identifikátor požadavku použitý pro odeslanou zprávu příjemci.
Example: "bc36f3d1-d284-463a-921b-a3560c154649"
Unikátní identifikátor zprávy použitý pro odeslanou zprávu příjemci.
Example: "e27ff0ac-87b5-4e1d-b644-5fc6029e2a11"
Použitý flow pro zprávu. Info: pro whatsapp_body a whatsapp_template obdržíte pouze whatsapp (příchozí zprávy nejsou rozděleny na whatsapp_body nebo whatsapp_template).
Enum"sms""viber""whatsapp"
Čas odeslání zprávy ve formátu Unix timestamp. Jedná se o časové razítko odeslání zprávy odesílatelem (pokud tato informace není k dispozici, timestamp odpovídající přijetí zprávy naším systémem).
Example: 1700000000
Odesílatel zprávy. V některých zemích nebo u některých operátorů není alfanumerický odesílatel plně podporován.
Example: "420777123456"
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/incomingReplyMessage
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/incomingReplyMessage
application/json
[ { "request_id": "bc36f3d1-d284-463a-921b-a3560c154649", "message_id": "e27ff0ac-87b5-4e1d-b644-5fc6029e2a11", "payload": { … }, "gateway": "sms", "timestamp": 1700000000, "type": "incoming", "sender": "420777123456", "recipient": "420777654321", "body": "Thank you!" } ]
Bodyapplication/jsonrequiredArray [
Čas odeslání zprávy ve formátu Unix timestamp. Jedná se o časové razítko odeslání zprávy odesílatelem (pokud tato informace není k dispozici, timestamp odpovídající přijetí zprávy naším systémem).
Example: 1700000000
Odesílatel zprávy. V některých zemích nebo u některých operátorů není alfanumerický odesílatel plně podporován.
Example: "420777123456"
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/incomingMessage
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/incomingMessage
application/json
[ { "gateway": "whatsapp", "timestamp": 1700000000, "type": "incoming", "sender": "420777123456", "recipient": "420777654321", "body": "Hello, I have a question." } ]