Přejít k obsahu
OmniMessage

Typy zpráv

Devět typů zpráv, jedno tělo požadavku

Požadavek na odeslání určuje kanál, příjemce a typ; obsah je pod klíčem pojmenovaným podle typu. Na této stránce najdete každý typ, tělo požadavku, ze kterého vzniká, a kde je podporován.

Otevřít referenci APIPorovnat kanály

Matice podpory

Který kanál přijímá který typ

Kanál uvádí, co přijímá, v poli capabilities. Odeslání typu, který kanál nepodporuje, vrátí 400 unsupported_message_type a nic se neúčtuje.

Podpora typů zpráv podle typu kanálu
TypWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
TexttextPodporovánoPodporovánoPodporovánoPodporovánoPodporovánoPodporovánoPodporováno
PřílohyattachmentsPodporovánoPodporovánoNepodporovánoPodporovánoPodporovánoPodporovánoPodporováno
ŠablonatemplatePodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporováno
Tlačítka odpovědíbuttonPodporovánoNepodporovánoNepodporovánoPodporovánoPodporovánoPodporovánoPodporováno
SeznamlistPodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporováno
Tlačítko s URLcta_urlPodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporovánoNepodporováno
PolohalocationPodporovánoNepodporovánoNepodporovánoPodporovánoNepodporovánoNepodporovánoNepodporováno
KontaktycontactsPodporovánoNepodporovánoNepodporovánoPodporovánoNepodporovánoNepodporovánoNepodporováno
AnketapollNepodporovánoNepodporovánoNepodporovánoPodporovánoNepodporovánoNepodporovánoNepodporováno
type: "text"

Text

Prostý text, který přijímají všechny typy kanálů. Nastavením preview_url umožníte kanálu zobrazit náhled odkazu.

body: 1 až 4096 znaků.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Vaše objednávka #1042 byla odeslána. Sledovat ji můžete na https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Přílohy

Jedna mediální položka na zprávu, odkazovaná pomocí https URL: obrázek, video, dokument, zvuk, hlasová zpráva nebo nálepka, volitelně s popiskem.

Právě jedna položka. caption: nejvýše 1024 znaků.

  • 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": "Účtenka k objednávce #1042."
    }
  ]
}
type: "template"

Šablona

Schválená šablona WhatsApp s proměnnými. Šablony jsou jediné zprávy, které WhatsApp přijímá mimo 24hodinové okno zákaznické podpory.

name a language musí odpovídat některé schválené šabloně kanálu.

  • 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": "Tereza"
          },
          {
            "type": "text",
            "text": "#1042"
          },
          {
            "type": "text",
            "text": "18:00"
          }
        ]
      }
    ]
  }
}
type: "button"

Tlačítka odpovědí

Zpráva s nejvýše třemi rychlými odpověďmi. ID stisknutého tlačítka se vrátí na váš webhook v události message.received.

1 až 3 tlačítka. title: nejvýše 20 znaků.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Váš stůl pro dva je rezervován na dnešní večer v 19:30. Platí to stále?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Potvrdit"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Změnit termín"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Zrušit rezervaci"
          }
        }
      ]
    }
  }
}
type: "list"

Seznam

Nabídka, která se otevírá jedním tlačítkem, s řádky seskupenými do pojmenovaných oddílů.

action.button: nejvýše 20 znaků.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Který tým vám dnes může pomoci?"
    },
    "action": {
      "button": "Vybrat tým",
      "sections": [
        {
          "title": "Týmy",
          "rows": [
            {
              "id": "orders",
              "title": "Objednávky",
              "description": "Doručení, vratky a vrácení peněz"
            },
            {
              "id": "billing",
              "title": "Fakturace",
              "description": "Faktury a platební metody"
            },
            {
              "id": "technical",
              "title": "Technická podpora",
              "description": "Nastavení a řešení potíží"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

Tlačítko s URL

Zpráva s jedním tlačítkem, které otevírá URL: pro sledování zásilek, platby a přihlašovací odkazy.

Jedno tlačítko na zprávu.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Vaše zásilka je na cestě. Sledujte ji v reálném čase."
    },
    "action": {
      "parameters": {
        "display_text": "Sledovat objednávku",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Poloha

Špendlík s názvem a adresou, který se otevře v mapové aplikaci příjemce.

latitude a longitude se uvádějí v desetinných stupních.

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

Kontakty

Jedna nebo více vizitek. Pole se kanálu předává beze změny, takže používá formát kontaktů daného poskytovatele.

Příklad ukazuje formát kontaktů WhatsApp.

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

Anketa

Nativní anketa na Telegramu s otázkou a sadou možností.

Jen Telegram.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Kdy vám máme objednávku doručit?",
    "options": [
      "Dopoledne, 09:00 až 12:00",
      "Odpoledne, 12:00 až 17:00",
      "Večer, 17:00 až 21:00"
    ]
  }
}

Vyzkoušejte všechny typy v sandboxu

Každý účet má sandboxový kanál pro každý typ kanálu. Testovacím klíčem odešlete jakýkoli typ, který kanál podporuje, a nic se nedoručí ani nenaúčtuje.

Získat klíč APIPřečíst dokumentaci