Preskočiť na obsah
OmniMessage

Typy správ

Deväť typov správ, jedno telo požiadavky

Požiadavka na odoslanie uvádza kanál, príjemcu a typ, pričom obsah je pod kľúčom pomenovaným podľa typu. Táto stránka ukazuje každý typ, telo, ktoré ho vytvorí, a kde je podporovaný.

Otvoriť referenciu APIPorovnať kanály

Matica podpory

Ktorý kanál prijíma ktorý typ

Kanál uvádza, čo prijíma, v poli capabilities. Odoslanie typu, ktorý kanál nepodporuje, vráti 400 unsupported_message_type a nič sa neúčtuje.

Podpora typov správ podľa typu kanála
TypWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
TexttextPodporovanéPodporovanéPodporovanéPodporovanéPodporovanéPodporovanéPodporované
PrílohyattachmentsPodporovanéPodporovanéNepodporovanéPodporovanéPodporovanéPodporovanéPodporované
ŠablónatemplatePodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporované
Tlačidlá odpovedebuttonPodporovanéNepodporovanéNepodporovanéPodporovanéPodporovanéPodporovanéPodporované
ZoznamlistPodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporované
Tlačidlo s URLcta_urlPodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporovanéNepodporované
PolohalocationPodporovanéNepodporovanéNepodporovanéPodporovanéNepodporovanéNepodporovanéNepodporované
KontaktycontactsPodporovanéNepodporovanéNepodporovanéPodporovanéNepodporovanéNepodporovanéNepodporované
AnketapollNepodporovanéNepodporovanéNepodporovanéPodporovanéNepodporovanéNepodporovanéNepodporované
type: "text"

Text

Obyčajný text, ktorý prijíma každý typ kanála. Ak má kanál vykresliť náhľad odkazu, nastavte preview_url.

body: 1 až 4 096 znakov.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Vaša objednávka #1042 bola odoslaná. Sledujte ju na https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Prílohy

Jedna mediálna položka na správu, na ktorú odkazuje adresa URL s protokolom https: obrázok, video, dokument, zvuk, hlasová správa alebo nálepka, s voliteľným popisom.

Práve jedna položka. caption: najviac 1 024 znakov.

  • WhatsApp Business
  • SMS
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "attachments",
  "attachments": [
    {
      "type": "image",
      "url": "https://example.com/receipts/1042.jpg",
      "caption": "Váš doklad k objednávke #1042."
    }
  ]
}
type: "template"

Šablóna

Schválená šablóna WhatsApp s premennými. Šablóny sú jediné správy, ktoré WhatsApp prijíma mimo 24-hodinového okna zákazníckej podpory.

name a language sa musia zhodovať so schválenou šablónou kanála.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "template",
  "template": {
    "name": "order_out_for_delivery",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Jana"
          },
          {
            "type": "text",
            "text": "#1042"
          },
          {
            "type": "text",
            "text": "18:00"
          }
        ]
      }
    ]
  }
}
type: "button"

Tlačidlá odpovede

Správa s najviac tromi rýchlymi odpoveďami. ID tlačidla, na ktoré príjemca ťukol, sa vráti na váš webhook v udalosti message.received.

1 až 3 tlačidlá. title: najviac 20 znakov.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Váš stôl pre dvoch je rezervovaný na dnes večer o 19:30. Platí to stále?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Potvrdiť"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Zmeniť termín"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Zrušiť rezerváciu"
          }
        }
      ]
    }
  }
}
type: "list"

Zoznam

Ponuka, ktorá sa otvára jediným tlačidlom, s riadkami zoskupenými do pomenovaných sekcií.

action.button: najviac 20 znakov.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Ktorý tím vám dnes môže pomôcť?"
    },
    "action": {
      "button": "Vybrať tím",
      "sections": [
        {
          "title": "Tímy",
          "rows": [
            {
              "id": "orders",
              "title": "Objednávky",
              "description": "Doručenie, vrátenie tovaru a peňazí"
            },
            {
              "id": "billing",
              "title": "Fakturácia",
              "description": "Faktúry a spôsoby platby"
            },
            {
              "id": "technical",
              "title": "Technická podpora",
              "description": "Nastavenie a riešenie problémov"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

Tlačidlo s URL

Správa s jedným tlačidlom, ktoré otvára adresu URL; vhodná pre stránky na sledovanie zásielok, platby a prihlasovacie odkazy.

Jedno tlačidlo na správu.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Váš balík je na ceste. Sledujte ho v reálnom čase."
    },
    "action": {
      "parameters": {
        "display_text": "Sledovať objednávku",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Poloha

Špendlík s názvom a adresou, ktorý sa otvorí v mapovej aplikácii príjemcu.

latitude a longitude sú v desatinných stupňoch.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Výdajné miesto",
    "address": "Sheikh Zayed Road, Dubaj"
  }
}
type: "contacts"

Kontakty

Jedna alebo viac vizitiek kontaktov. Pole sa kanálu preposiela bez zmeny, takže používa vlastný formát kontaktov poskytovateľa.

Príklad ukazuje formát kontaktov WhatsApp.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Zákaznícka podpora",
        "first_name": "Podpora"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}
type: "poll"

Anketa

Natívna anketa Telegramu s otázkou a súborom možností.

Iba Telegram.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Kedy vám máme objednávku doručiť?",
    "options": [
      "Dopoludnia, 09:00 až 12:00",
      "Popoludní, 12:00 až 17:00",
      "Večer, 17:00 až 21:00"
    ]
  }
}

Vyskúšajte každý typ v sandboxe

Každý účet má sandboxový kanál pre každý typ kanála. Testovacím kľúčom pošlite ľubovoľný typ, ktorý kanál podporuje, a nič sa nedoručí ani nezaúčtuje.

Získať kľúč APIPrečítať dokumentáciu