Skip to main content
WhatsApp šablonu odešlete objektem whatsapp_template uvnitř pole flow. Kromě povinných polí (template_name, language, sender) můžete do šablony za běhu doplňovat obsah — proměnné v textu, media v hlavičce, dynamická tlačítka, produkty i časově omezené akce. Tato stránka je úplným referenčním přehledem těchto parametrů. Praktický úvod najdete v návodu Odeslat WhatsApp, rozdíl mezi šablonou a volným textem vysvětluje koncept Typy WhatsApp zpráv.

Povinná pole

Minimální šablona
Pole pro parametry přijímají dvě pojmenování jako aliasy: params / params_header / params_buttons (doporučené, konzistentní s JSON API v2) a starší parameters_body / parameters_header / parameters_buttons. V této referenci používáme tvar params_*.

Proměnné v těle zprávy (params)

Pole params vyplňuje proměnné v textu šablony. WhatsApp podporuje dva styly proměnných; podle toho, který jste zvolili při vytváření šablony, se liší zápis.

Očíslované proměnné

Šablona s očíslovanými proměnnými {{1}}, {{2}}:
Předejte pole řetězců — hodnoty se dosadí pozičně:

Pojmenované proměnné

Šablona s pojmenovanými proměnnými {{jmeno}}, {{den}}:
Předejte pole objektů s jedním klíčem = názvem proměnné:
Počet i pořadí hodnot musí odpovídat proměnným v šabloně. Chybějící nebo přebývající hodnota vede k zamítnutí zprávy (rejected).

Hlavička (params_header)

Pole params_header obsahuje vždy jediný prvek — WhatsApp šablona má nejvýše jednu hlavičku. Nejjednodušší zápis je řetězec; SmsManager podle jeho tvaru sám určí typ hlavičky:
Obrázek v hlavičce (zkrácený zápis)
Podporované formáty a limity: obrázek png/jpg do 5 MB, video mp4/3gp (H.264 + AAC, se zvukovou stopou) do 16 MB, dokument pdf do 100 MB.

Explicitní zápis hlavičky

Místo řetězce můžete předat objekt a typ hlavičky určit explicitně. To využijete pro media přes objekt s link, textovou proměnnou, polohu nebo produkt.
Textová hlavička s proměnnou
Obrázek dokument
Poloha
Produkt (Single-Product Message)

Tlačítka (params_buttons)

Pole params_buttons doplňuje parametry tlačítek. Hodnoty se přiřazují pozičně ke tlačítkům v šabloně, proto na pozici statického tlačítka (bez parametru) vložte null.
Statická tlačítka (pevná URL nebo telefonní číslo) při odesílání uvádět nemusíte. Dynamická tlačítka a tlačítka s vyžadovanými parametry musíte uvést vždy a ve správném pořadí.
Jen druhé tlačítko je dynamické
Typ tlačítka určíte tvarem hodnoty:
Kupónové tlačítko používá klíč code ({ "code": "ABCD10" }), nikoli coupon.

Multi-produkt (MPM)

Klíčem objektu je product_retailer_id náhledového produktu, hodnotou je pole sekcí katalogu:

Flow tlačítko

Flow tlačítko musí být v požadavku uvedeno, i když nepředáváte žádná data — v takovém případě použijte null. Pro předvyplnění formuláře předejte objekt s daty:
Bez dat
S předvyplněnými daty

Pole params_carousel odešle šablonu typu carousel — pole karet, každá s jedním produktem:

Časově omezená akce (params_lto)

Pole params_lto nastavuje konec platnosti nabídky u šablony typu Limited Time Offer. Hodnotou je timestamp v milisekundách (řetězec nebo číslo):
Odpočet LTO se zobrazuje pouze v mobilní aplikaci WhatsApp, ne ve webovém klientovi ani na počítači.

Kompletní příklad

Šablona s pojmenovanou proměnnou v těle, obrázkem v hlavičce, dynamickým URL tlačítkem a SMS zálohou:
cURL

Další kroky

Odeslat WhatsApp

Praktický průvodce odesíláním šablon i volného textu.

Typy WhatsApp zpráv

Kdy použít šablonu a kdy volný text v 24hodinovém okně.

SMS záloha pro WhatsApp

Automatický přechod na SMS, když WhatsApp selže.

Webhooky

Stavy doručení WhatsApp a formát doručenek.