Hromadné odesílání zpráv

Intro

Princip odesílání zpráv je stejný, jako případě kdy odesíláte jednu zprávu, pouze pro více (až 10) příjemců.

Rozdíl je v tom, že použití tohoto endpointu umožňuje zaslat až 10 unikátních zpráv vždy pro jednoho příjemce a nebo až 10 stejných zpráv pro 1-10 různých příjemců (dohromady tedy až 100 zpráv v jednom HTTP požadavku).

Rychlost zpracování požadavku je přibližně stejná, jako při odesílání jedné zprávy a pohybuje se okolo 100-200ms. Tímto způsobem lze tedy odesílat až 500-1000 zpráv za vteřinu při odesílání stejné zprávy pro více příjemců (až 10 příjemců v jednom objektu a až 10 objektů v jednom poli).

Info

Tento endpoint vyžaduje pro správné párování doručenek upravený formát ID zprávy, který neodpovídá formátu UUID v4 a je nutné si jej dovodit na základě toho jakým způsobem zprávy na tento endpoint zasíláte. Více informací naleznete v dokumentaci k doručenkám.

Endpoint

HTTP Metoda: POST
Endpoint: https://api.smsmngr.com
Metoda: /v2/messages

HTTP hlavičky

Název	Popis
Content-Type	application/json
x-api-key	<API klíč>

JSON objekt (body)

Endpoint vyžaduje zaslání minimálně jednoho objektu v poli.

[
  {
    "body": "Text zprávy",
    "to": [
    {
      "phone_number": "420777777777"
      }
    ]
  }
]

Parametr	Popis	Povinný
body	Text zprávy	Ano
to	Pole objektů příjemců Příklad: [{"phone_number": "420777777777"}]	Ano, maximálně 10 příjemců

Odpověď (200 OK)

HTTP: 200 OK
Content-Type: application/json
Odpověď se vrací v JSON formátu.

{
  "request_id": "db013db1-d1e7-47e6-92d1-0f894a6ba9d5",
  "accepted": [
    {
      "key": "0",
      "message_id": "7fb90b5f-cce6-4634-ac76-50922b4825d3"
    }
  ],
  "rejected": []
}

Hodnota	Popis
request_id	ID žádosti
accepted	Pole objektů přijatých zpráv
rejected	Pole objektů odmítnutých zpráv

Hodnota key

Hodnota key je číslována od nuly (ve smyslu indexu) a odpovídá pořadí objektu v poli z původního JSON, který byl na API zaslán.

Objekt přijatých zpráv

Hodnota	Popis
key	Pořadí objektu v poli
message_id	ID objektu Dle tohoto ID je možné zprávu identifikovat (dohledat v systému, spárovat doručenku apod.). Nicméně je nutné toto ID obohatit o pořadí příjence v poli to odděleného pomocí -. Více informací o spárování doručenek naleznete v dokumentaci k doručenkám

Objekt odmítnutých zpráv

Hodnota	Popis
key	Pořadí zprávy v poli

Info

Pozor, odpověď 200 OK a zároveň přidělení ID zprávy neznamená, že zpráva je odeslána. Zpráva je v tomto stavu pouze přijata k odeslání a uložena do fronty.