Specifikace WhatsApp objektu

WhatsApp objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
sender	Textový odesílatel. Musí být nejdříve registrován. Pro registraci kontaktujte podporu zde.	Ano	-
expiration	Časový limit po kterém bude použit alternativní kanál	Ne	3600
template	Template objekt. Nemůže být použít současně s následujícími parametry (Message, File, Otp, Location), viz Template objekt	Ne	null
message	Message objekt. Nemůže být použít současně s následujícími parametry (Template, File, Otp, Location), viz Message objekt	Ne	null
file	File objekt. Nemůže být použít současně s následujícími parametry (Template, Message, Otp, Location), viz File objekt	Ne	null
otp	Otp objekt. Nemůže být použít současně s následujícími parametry (Template, Message, File, Location), viz Otp objekt	Ne	null
location	Location objekt. Nemůže být použít současně s následujícími parametry (Template, Message, File, Otp), viz Location objekt	Ne	null

Template objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
template	Text šablony	Ne	null
language	Jazyk šablony zadán v ISO formátu	Ne	en
header	Objekt hlavičky šablony, viz Hlavička šablony	Ne	null
body	Objekt těla šablony, viz Tělo šablony	Ne	null
buttons	Pole objektů tlačítek šablony, viz Tlačítka	Ne	null

Template header objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ hlavičky (image, video, text, location)	Ano	-
url	Cesta k souboru videa, nebo obrazku (používané s typem image, video)	Ano, ne současně s následujícími typy (text, location)	-
caption	Popisek souboru (použivané s typem image, video)	Ano, ne současně s následujícími typy (text, location)	-
text	Text (použití s typem text)	Ano, ne současně s následujícími typy (url, caption, location)	-
location	Objekt lokace (použití s typem location), viz Objekt lokace	Ano, ne současně s následujícími typy (url, text, caption)	-

Template body objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ těla (text, price, currency)	Ne	text
text	Text (použití s typem text)	Ano, ne současně s následujícími typy (amount, currency)	-
amount	Množství	Ano, ne současně s následujícími typy (text)	-
currency	Měna	Ano, ne současně s následujícími typy (text)	-

Template buttons objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ tlačítka (payload, url)	Ne	text
index	Index definovaného tlačítka	Ano	-
payload	Meta data zaslaná při kliknutí na tlačítko	Ano, pouze při použití s payload typem	-
text	Url na které bude přijemne přesměrován	Ano, pouze při použití s url typem	-

Příklad požadavku template objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "whatsapp": {
      "sender": "420777777777",
      "expiration": 300,
      "template": {
        "template": "test_template",
        "language": "cz",
        "header": {
          "type": "image",
          "url": "test_url",
          "caption": "test_caption"
        },
        "body": [
          {
            "type": "currency",
            "amount": 20.5,
            "currency": "euro"
          }
        ],
        "buttons": [
          {
            "type": "payload",
            "index": 1,
            "payload": "test_payload"
          }
        ]
      }
    }
  }
}

Příklad Template objektu

Message objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
text	Text zprávy	Ano	-
preview_url	Náhled stránky ve zprávě	Ne	true

Příklad message objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "whatsapp": {
      "sender": "420777777777",
      "expiration": 300,
      "message": {
        "text": "title",
        "preview_url": true
      }
    }
  }
}

File objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
type	Typ souboru (image, video, audio, document, sticker)	Ne	image
url	Cesta k souboru	Ano	-
caption	Popisek souboru	Ne	""

Příklad požadavku File objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "whatsapp": {
      "sender": "420777777777",
      "expiration": 300,
      "file": {
        "type": "image",
        "url": "url_test",
        "caption": "caption_test"
      }
    }
  }
}

Příklad File objektu

Otp objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
template	Šablona textové zprávy obsahující kód	Ano	-
code	Jednorázový kód	Ano	-
language	Jazyk který má být použitý při odelání kódu (pokud je nastaven null jazyk bude detekován z telefonního čísla)	Ano	-

Příklad of Otp objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "whatsapp": {
      "sender": "420777777777",
      "expiration": 300,
      "otp": {
        "template": "test_template",
        "language": "cz",
        "code": "0451"
      }
    }
  }
}

Location objekt

NÁZEV PARAMETRU	HODNOTA	POVINNÝ	VÝCHOZÍ HODNOTA
latitude	Zeměpisná šířka ve formě desetinného čísla	Ne	-
longitude	Zeměpisná výška ve formě desetinného čísla	Ne	-
name	Jméno lokace	Ne	-
address	Adresa lokace	Ne	-

Příklad požadavku Location objektu:

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",
  "number": [
    "+420777777777"
  ],
  "text": "Test text",
  "channel": {
    "whatsapp": {
      "sender": "420777777777",
      "expiration": 300,
      "location": {
        "latitude": 0.1,
        "longitude": 0.1,
        "name": "test_name",
        "address": "test_address"
      }
    }
  }
}

Příklad Location objektu