Sõnumitüübid

Üheksa sõnumitüüpi, üks päringu keha

Saatmispäring nimetab kanali, adressaadi ja tüübi ning sisu asub tüübi järgi nimetatud võtme all. See leht näitab iga tüüpi, seda tekitavat keha ja seda, kus tüüpi toetatakse.

Ava API teatmik Võrdle kanaleid

Toemaatriks

Milline kanal millist tüüpi vastu võtab

Kanal annab väljal capabilities teada, mida ta vastu võtab. Kui saadad tüübi, mida kanal ei toeta, on vastuseks 400 unsupported_message_type ja tasu ei võeta.

Sõnumitüüpide tugi kanalitüüpide kaupa
Tüüp	WhatsApp	SMS	SMS OTP	Telegram	Messenger	Instagram	TikTok
Tekst`text`	Toetatud	Toetatud	Toetatud	Toetatud	Toetatud	Toetatud	Toetatud
Manused`attachments`	Toetatud	Toetatud	Ei toetata	Toetatud	Toetatud	Toetatud	Toetatud
Mall`template`	Toetatud	Ei toetata	Ei toetata	Ei toetata	Ei toetata	Ei toetata	Ei toetata
Vastusenupud`button`	Toetatud	Ei toetata	Ei toetata	Toetatud	Toetatud	Toetatud	Toetatud
Loend`list`	Toetatud	Ei toetata	Ei toetata	Ei toetata	Ei toetata	Ei toetata	Ei toetata
URL-nupp`cta_url`	Toetatud	Ei toetata	Ei toetata	Ei toetata	Ei toetata	Ei toetata	Ei toetata
Asukoht`location`	Toetatud	Ei toetata	Ei toetata	Toetatud	Ei toetata	Ei toetata	Ei toetata
Kontaktid`contacts`	Toetatud	Ei toetata	Ei toetata	Toetatud	Ei toetata	Ei toetata	Ei toetata
Küsitlus`poll`	Ei toetata	Ei toetata	Ei toetata	Toetatud	Ei toetata	Ei toetata	Ei toetata

type: "text"

Tekst

Lihttekst, mille võtab vastu iga kanalitüüp. Määra preview_url, et kanal kuvaks lingi eelvaate.

body: 1 kuni 4096 märki.

WhatsApp Business
SMS
SMS OTP
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Sinu tellimus #1042 on teele pandud. Jälgi seda aadressil https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}

type: "attachments"

Manused

Üks meediaüksus sõnumi kohta, viidatud https-URL-iga: pilt, video, dokument, heli, häälsõnum või kleeps, soovi korral koos allkirjaga.

Täpselt üks üksus. caption: kuni 1024 märki.

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": "Sinu kviitung tellimuse #1042 kohta."
    }
  ]
}

type: "template"

Mall

Heakskiidetud WhatsAppi mall koos muutujatega. Mallid on ainsad sõnumid, mida WhatsApp võtab vastu väljaspool 24-tunnist klienditeeninduse akent.

name ja language peavad vastama kanali heakskiidetud mallile.

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

type: "button"

Vastusenupud

Sõnum kuni kolme kiirvastusega. Puudutatud nupu ID jõuab sinu veebihaagile tagasi message.received-sündmuses.

1 kuni 3 nuppu. title: kuni 20 märki.

WhatsApp Business
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Teie laud kahele on broneeritud täna õhtul kella 19.30-ks. Kas saate ikka tulla?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Kinnita"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Muuda aega"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Tühista broneering"
          }
        }
      ]
    }
  }
}

type: "list"

Loend

Ühest nupust avanev menüü, mille read on rühmitatud pealkirjastatud jaotistesse.

action.button: kuni 20 märki.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Milline meeskond saab sind täna aidata?"
    },
    "action": {
      "button": "Vali meeskond",
      "sections": [
        {
          "title": "Meeskonnad",
          "rows": [
            {
              "id": "orders",
              "title": "Tellimused",
              "description": "Tarne, tagastused ja tagasimaksed"
            },
            {
              "id": "billing",
              "title": "Arveldus",
              "description": "Arved ja makseviisid"
            },
            {
              "id": "technical",
              "title": "Tehniline tugi",
              "description": "Seadistamine ja tõrkeotsing"
            }
          ]
        }
      ]
    }
  }
}

type: "cta_url"

URL-nupp

Sõnum ühe nupuga, mis avab URL-i: jälgimislehtede, maksete ja sisselogimislinkide jaoks.

Üks nupp sõnumi kohta.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Sinu pakk on teel. Jälgi seda reaalajas."
    },
    "action": {
      "parameters": {
        "display_text": "Jälgi tellimust",
        "url": "https://example.com/t/1042"
      }
    }
  }
}

type: "location"

Asukoht

Nime ja aadressiga kaardimärk, mis avaneb saaja kaardirakenduses.

latitude ja longitude on kümnendkraadides.

WhatsApp Business
Telegram

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Väljastuspunkt",
    "address": "Sheikh Zayed Road, Dubai"
  }
}

type: "contacts"

Kontaktid

Üks või mitu kontaktikaarti. Massiiv edastatakse kanalile muutmata kujul, seega kasutab see teenusepakkuja enda kontaktivormingut.

Näites on WhatsAppi kontaktivorming.

WhatsApp Business
Telegram

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Klienditugi",
        "first_name": "Tugi"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}

type: "poll"

Küsitlus

Telegrami oma küsitlus küsimuse ja valikuvariantidega.

Ainult Telegram.

POST /v1/messages

{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Millal sinu tellimuse kohale toome?",
    "options": [
      "Hommikul, 9.00–12.00",
      "Pärastlõunal, 12.00–17.00",
      "Õhtul, 17.00–21.00"
    ]
  }
}

Proovi iga tüüpi liivakastis

Igal kontol on iga kanalitüübi jaoks liivakastikanal. Saada testvõtmega mis tahes tüüpi, mida see toetab – midagi ei toimetata kohale ega arveldata.

Hangi API võti Loe dokumentatsiooni