Odesílání zpráv

Intro

Tento endpoint je nejjednodušší způsob, jak odeslat zprávu k nám do systému. Rychlost zpracování požadavku se pohybuje okolo 100-200ms.

Tímto způsobem lze tedy odesílat až 5-10 zpráv za vteřinu pokud odesíláte zprávu pro jednoho příjemce nebo 50-100 zpráv za vteřinu pokud odesíláte zprávy pro více příjemců (až 10 příjemců v jednom požadavku) v jednom vlákně. API neomezuje počet paralelních vláken, které lze použít.

Propustnost

Limitujeme celkovou propustnost dle API klíče.

Tip

Pro podrobný popis API doporučujeme referenční příručku JSON API.

Endpoint

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

HTTP hlavičky

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

JSON objekt (body)

Toto je minimální objekt, který je nutné poslat pro odeslání zprávy.

{
  "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ů
callback	URL adresa, na kterou se mají doručenky odesílat	Ne
payload	JSON objekt, který je zasílán zpráv na callback URL pro možnost předat vlastní metadata	Ne
datetime	Odeslání zprávy v nastavený den a čas	Ne
delivery_time	Definice časového okna kdy jsou zprávy odesílány. Lze vybrat dny a čas začátku a konce odesílání. Např. Pondělí - Pátek 8:00-20:00. V případě odesílání mimo časové okno bude odesílání naplánováno na nejbližší začátek časového okna (pro tento příklad tedy platí, že request zaslaný na API v pondělí v 21:00 bude odeslán až v úterý v 8:00. Request zaslaný na API v sobotu v 10:00 bude odeslán až v pondělí v 8:00).	Ne
flow	Pole, které definuje jakým způsobem se má zpráva odeslat (využití kanálů)	Ne

Další příklady

{
  "body": "Text zprávy",
  "flow": [
    {
      "sms": {
        "sender": "MojeFirma",
        "gateway": "high"
      }
    }
  ],
  "to": [
    {
      "phone_number": "420777777777"
    }
  ]
}

{
  "body": "Text zprávy",
  "callback": "https://moje-firmy-web.cz/api/v2/callback",
  "flow": [
    {
      "sms": {
        "sender": "MojeFirma",
        "gateway": "high"
      }
    }
  ],
  "to": [
    {
      "phone_number": "420777777777"
    }
  ]
}

{
  "body": "Text zprávy",
  "delivery_time":{
    "days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "start": "08:00",
    "end": "20:00"
  },
  "flow": [
    {
      "sms": {
        "sender": "MojeFirma",
        "gateway": "high"
      }
    }
  ],
  "to": [
    {
      "phone_number": "420777777777"
    }
  ]
}

Odpověď

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í zprávy v poli to z původního JSON objektu, který byl na API zaslán.

Objekt přijatých zpráv

Hodnota	Popis
key	Pořadí zprávy v poli
message_id	ID zprávy Dle tohoto ID je možné zprávu identifikovat (dohledat v systému, spárovat doručenku apod.)

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.