Pereiti prie turinio
OmniMessage

Žinučių tipai

Devyni žinučių tipai, vienas užklausos turinys

Siuntimo užklausoje nurodomas kanalas, gavėjas ir tipas, o turinys pateikiamas po raktu, pavadintu pagal tipą. Šiame puslapyje parodytas kiekvienas tipas, jį sukuriantis užklausos turinys ir kur jis palaikomas.

Atidaryti API žinynąPalyginti kanalus

Palaikymo lentelė

Kuris kanalas priima kurį tipą

Kanalas lauke capabilities nurodo, ką jis priima. Išsiuntus tipą, kurio kanalas nepalaiko, grąžinama klaida 400 unsupported_message_type ir mokestis neimamas.

Žinučių tipų palaikymas pagal kanalo tipą
TipasWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
TekstastextPalaikomaPalaikomaPalaikomaPalaikomaPalaikomaPalaikomaPalaikoma
PriedaiattachmentsPalaikomaPalaikomaNepalaikomaPalaikomaPalaikomaPalaikomaPalaikoma
ŠablonastemplatePalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikoma
Atsakymo mygtukaibuttonPalaikomaNepalaikomaNepalaikomaPalaikomaPalaikomaPalaikomaPalaikoma
SąrašaslistPalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikoma
URL mygtukascta_urlPalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikomaNepalaikoma
VietalocationPalaikomaNepalaikomaNepalaikomaPalaikomaNepalaikomaNepalaikomaNepalaikoma
KontaktaicontactsPalaikomaNepalaikomaNepalaikomaPalaikomaNepalaikomaNepalaikomaNepalaikoma
ApklausapollNepalaikomaNepalaikomaNepalaikomaPalaikomaNepalaikomaNepalaikomaNepalaikoma
type: "text"

Tekstas

Paprastas tekstas, kurį priima visi kanalų tipai. Nustatykite preview_url, kad kanalas atvaizduotų nuorodos peržiūrą.

body: nuo 1 iki 4096 simbolių.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Jūsų užsakymas #1042 išsiųstas. Sekite jį čia: https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Priedai

Vienas medijos elementas žinutėje, nurodomas https URL: paveikslėlis, vaizdo įrašas, dokumentas, garso įrašas, balso žinutė arba lipdukas su neprivaloma antrašte.

Lygiai vienas elementas. caption: iki 1024 simbolių.

  • 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": "Jūsų užsakymo #1042 kvitas."
    }
  ]
}
type: "template"

Šablonas

Patvirtintas „WhatsApp“ šablonas su kintamaisiais. Šablonai – vienintelės žinutės, kurias „WhatsApp“ priima ne 24 valandų klientų aptarnavimo lange.

name ir language turi atitikti patvirtintą kanalo šabloną.

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

Atsakymo mygtukai

Žinutė su ne daugiau kaip trimis greitaisiais atsakymais. Paspausto mygtuko ID grįžta į jūsų webhook’ą įvykyje message.received.

Nuo 1 iki 3 mygtukų. title: iki 20 simbolių.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Jūsų staliukas dviem rezervuotas šį vakarą 19:30. Ar vis dar galėsite atvykti?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Patvirtinti"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Perkelti"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Atšaukti rezervaciją"
          }
        }
      ]
    }
  }
}
type: "list"

Sąrašas

Meniu, atidaromas vienu mygtuku, kurio eilutės sugrupuotos į skyrius su pavadinimais.

action.button: iki 20 simbolių.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Kuri komanda gali jums šiandien padėti?"
    },
    "action": {
      "button": "Pasirinkti komandą",
      "sections": [
        {
          "title": "Komandos",
          "rows": [
            {
              "id": "orders",
              "title": "Užsakymai",
              "description": "Pristatymas, prekių ir pinigų grąžinimas"
            },
            {
              "id": "billing",
              "title": "Atsiskaitymas",
              "description": "Sąskaitos faktūros ir mokėjimo būdai"
            },
            {
              "id": "technical",
              "title": "Techninė pagalba",
              "description": "Nustatymas ir trikčių šalinimas"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

URL mygtukas

Žinutė su vienu mygtuku, atidarančiu URL, – sekimo puslapiams, mokėjimams ir prisijungimo nuorodoms.

Vienas mygtukas žinutėje.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Jūsų siunta jau pakeliui. Sekite ją tikruoju laiku."
    },
    "action": {
      "parameters": {
        "display_text": "Sekti užsakymą",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Vieta

Žymeklis su pavadinimu ir adresu, atidaromas gavėjo žemėlapių programoje.

latitude ir longitude nurodomi dešimtainiais laipsniais.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Atsiėmimo punktas",
    "address": "Sheikh Zayed Road, Dubajus"
  }
}
type: "contacts"

Kontaktai

Viena arba kelios kontaktų kortelės. Masyvas persiunčiamas kanalui nepakeistas, todėl jame naudojamas teikėjo kontaktų formatas.

Pavyzdyje parodytas „WhatsApp“ kontaktų formatas.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Pagalbos tarnyba",
        "first_name": "Pagalba"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}
type: "poll"

Apklausa

Integruota „Telegram“ apklausa su klausimu ir atsakymų variantais.

Tik „Telegram“.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Kada pristatyti jūsų užsakymą?",
    "options": [
      "Ryte, 09:00–12:00",
      "Po pietų, 12:00–17:00",
      "Vakare, 17:00–21:00"
    ]
  }
}

Išbandykite visus tipus smėliadėžėje

Kiekviena paskyra turi po smėliadėžės kanalą kiekvienam kanalo tipui. Naudodami bandomąjį raktą siųskite bet kurį jo palaikomą tipą – niekas nepristatoma ir už nieką neimamas mokestis.

Gauti API raktąSkaityti dokumentaciją