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.
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/
https://api.smsmngr.com/v2/
Seznam příjemců.
URL pro zpětné volání pro příjem oznámení o doručení (Webhook, viz Webhooks).
Tag pro zprávu. Můžete jej použít k seskupování zpráv (např. podle ID kampaně). Existují také speciální tagy, které můžete použít: priority (pro prioritní zprávy), transactional (pro transakční zprávy).
Poskytnutím tohoto objektu můžete zprávě předat speciální parametry. Zeptejte se nás, jak tento parametr použít pro zkracování odkazů nebo jiné funkce.
Naplánovaný čas odeslání zprávy. Vždy v časovém pásmu UTC.
Seznam komunikačních kanálů pro tok zprávy. Pokud je definován, nesmí být prázdný. Můžete použít více kanálů, pořadí kanálů je důležité (první kanál se použije jako první, pokud první kanál není dostupný nebo jej příjemce nepřijme, použije se druhý kanál atd.).
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/message
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/message
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/message \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"body": "Test message",
"to": [
{
"phone_number": "420777123456"
}
]
}'{ "request_id": "string", "accepted": [ { … } ], "rejected": [ { … } ] }
Request
Tento endpoint slouží k hromadnému odeslání identických zpráv více příjemcům (můžete nastavit až 10 příjemců na jeden požadavek a až 10 požadavků na jedno volání API). To znamená, že můžete odeslat až 100 příjemcům v rámci jednoho volání HTTP API. Pokud chcete použít jiné kanály než SMS (Viber, WhatsApp atd.), musíte použít vlastnost flow. Při použití tohoto endpointu obdržíte message_id pro každý z požadavků (nikoli pro každého příjemce). Chcete-li získat message_id pro každého příjemce, musíte k message_id připojit -<index_příjemce>. Více informací o message_id naleznete v dokumentaci.
Seznam příjemců.
URL pro zpětné volání pro příjem oznámení o doručení (Webhook, viz Webhooks).
Tag pro zprávu. Můžete jej použít k seskupování zpráv (např. podle ID kampaně). Existují také speciální tagy, které můžete použít: priority (pro prioritní zprávy), transactional (pro transakční zprávy).
Poskytnutím tohoto objektu můžete zprávě předat speciální parametry. Zeptejte se nás, jak tento parametr použít pro zkracování odkazů nebo jiné funkce.
Naplánovaný čas odeslání zprávy. Vždy v časovém pásmu UTC.
Seznam komunikačních kanálů pro tok zprávy. Pokud je definován, nesmí být prázdný. Můžete použít více kanálů, pořadí kanálů je důležité (první kanál se použije jako první, pokud první kanál není dostupný nebo jej příjemce nepřijme, použije se druhý kanál atd.).
Můžete dokonce vytvořit pro zprávu payload, kde můžete definovat jakékoli parametry pro zprávu. Tento objekt je vrácen v oznámení o doručení a odpovědích.
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/messages
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/messages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/messages \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"body": "Hello John",
"to": [
{
"phone_number": "420777123456"
},
{
"phone_number": "420777654321"
}
]
},
{
"body": "Hello Jane",
"to": [
{
"phone_number": "420777115577"
},
{
"phone_number": "420777223344"
}
]
}
]'Dva požadavky s více příjemci. Buďte opatrní, když používáte koncový bod messages, obdržíte message_id pro každý z požadavků (ne pro každého příjemce). Pro získání message_id pro každého příjemce musíte k message_id připojit -<index_příjemce>. Například, pokud máte dva příjemce pro první požadavek, první příjemce bude mít message_id pppppppp-qqqq-rrrr-ssss-tttttttttttt-0 a druhý příjemce bude mít message_id pppppppp-qqqq-rrrr-ssss-tttttttttttt-1.
{ "request_id": "66666666-6666-6666-6666-666666666666", "accepted": [ { … }, { … } ], "rejected": [] }
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/simple/message
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/simple/message
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/simple/message?apikey=string%2CYOUR_API_KEY_HERE&phone_number=string&message=string&sender=string'{ "request_id": "66666666-6666-6666-6666-666666666666", "message_id": "pppppppp-qqqq-rrrr-ssss-tttttttttttt", "accepted": true }
- Mock server
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/simple/message
- Odpoví s daty vašeho požadavku
https://api.smsmngr.com/v2/simple/message
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-ref.smsmanager.com/_mock/openapi/cs/json/jsonapi_v2/simple/message \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d phone_number=string \
-d message=string \
-d sender=string{ "request_id": "11111111-1111-1111-1111-111111111111", "message_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "accepted": true }