Skip to main content
POST

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
to
object[]
required

Seznam příjemců.

Required array length: 1 - 10 elements
​
body
string

Tělo zprávy (pokud není definováno ve flow). Tělo je povinné buď zde v kořenovém objektu, nebo v kroku flow. Delší texty jsou zkráceny na 1000 znaků.

Maximum string length: 1000
​
sender
string

Výchozí odesílatel pro všechny kroky flow. Pokud krok flow definuje vlastní sender, má hodnota z kroku flow vyšší prioritu. Alfanumerický název odesílatele (max. 11 znaků, může být vyžadována předchozí registrace) nebo dedikované virtuální číslo (bez +).

Examples:

"Mojefirma"

"420777123456"

​
callback

Callback URL pro příjem notifikací o doručení (Webhook, viz Webhooks). Můžete předat prostý řetězec s URL, nebo objekt s rozšířenou konfigurací callbacku.

​
tag
string
default:promotional

Tag zprávy. Můžete jej použít pro seskupování zpráv (např. podle id kampaně). Více tagů lze předat oddělených čárkou. Tagy jsou normalizovány na malá písmena a jsou zachovány pouze znaky a-z, 0-9, -, . a _. Existují také speciální tagy: priority (pro prioritní zprávy), transactional (pro transakční zprávy). Zprávy s výchozím tagem promotional jsou kontrolovány proti opt-out seznamu příjemců.

​
messageTag
string
deprecated

Zastaralý alias pole tag. Použijte tag.

​
params
object

Tímto objektem můžete zprávě předat speciální parametry, např. automatické zkracování odkazů přes objekt _url. Zeptejte se nás, jak tento parametr použít pro další funkce.

​
datetime
string<date-time>

Naplánovaný čas odeslání zprávy. Vždy v UTC. Pokud je čas více než 1 minutu v budoucnosti, zpráva je naplánována a zpracována v daný čas. Časy v minulosti jsou odeslány okamžitě.

Example:

"2025-01-11T10:00:00Z"

​
delivery_time
object

Povolené doručovací okno. Pokud je aktuální (nebo naplánovaný) čas mimo okno, odeslání se posune na nejbližší platný čas.

​
flow
object[]

Seznam komunikačních kanálů pro flow zprávy. Pokud je definován, nesmí být prázdný. Můžete použít více kanálů, na pořadí záleží (první kanál se použije jako první; pokud krok definuje ttl a jeho ttl_condition není v rámci TTL splněna, použije se další kanál, atd.). Pokud flow není definováno, použije se výchozí [{"sms": {"gateway": "high"}}].

​
payload
object

Můžete odeslat payload zprávy, kde si můžete definovat libovolné parametry zprávy. Tento objekt je vrácen v notifikaci o doručení a v odpovědích.

Example:

Response

Zprávy byly úspěšně odeslány

​
request_id
string

Unikátní identifikátor požadavku.

​
accepted
object[]
​
rejected
object[]