Odeslání SMS
Endpoint
HTTP Metoda: POST
nebo GET
Adresa endpointu: https://http-api.smsmanager.cz/Send
Doporučujeme
Doporučujeme používat POST
metodu.
HTTP hlavičky
Název | Popis |
---|---|
Content-Type | application/x-www-form-urlencoded |
POST / GET Parametry
Parametr | Popis | Povinný |
---|---|---|
apikey | API klíč, který lze získat z administrace | Ano |
number | Telefonní číslo Příklad: 420777111222 | Ano |
message | Text zprávy | Ano |
sender | Odesílatel | Ne |
gateway | Typ odesílání | Ne |
time | Datum a čas odeslání zprávy. Příklad: 2025-01-01T23:59:59 | Ne |
type | Nastavení typu zprávy Pro zachování diakritiky v SMS použijte hodnotu: utf | Ne |
Odpověď
HTTP: 200 OK
Content-Type: text/plain
Odpověď se vrací v textovém formátu.
OK|550e8400-e29b-41d4-a716-446655440000|420777111222
Hodnota | Popis |
---|---|
OK | Zpráva byla úspěšně přijata k odeslání a uložena do fronty |
550e8400-e29b-41d4-a716-446655440000 | ID zprávy |
420777111222 | Telefonní číslo |
Pozor
ID zprávy je unikátní identifikátor pro danou zprávu. Dle tohoto ID je možné zprávu identifikovat (dohledat v systému, spárovat doručenku apod.). Momentálně může být hodnotou číslo (int) nebo řetězec (string). V budoucích verzích se bude vracet pouze řetězec v běžném formátu UUID v4.
Info
Po odpovědi OK
nelze o čekávat, že je zpráva odeslána. Zpráva je v tomto stavu pouze přijata k odeslání a uložena do fronty.
Chyba
HTTP: 200 OK
Content-Type: text/plain
Odpověď se vrací v textovém formátu.
ERROR|102
Hodnota | Popis |
---|---|
ERROR | Zpráva nebyla odeslána |
102 | Číslo chyby |