Vrste sporočil

Devet vrst sporočil, eno telo zahteve

Zahteva za pošiljanje navaja kanal, prejemnika in vrsto, vsebina pa je pod ključem, poimenovanim po tej vrsti. Na tej strani so prikazani vse vrste, telo zahteve, ki posamezno vrsto ustvari, in kanali, na katerih je podprta.

Odprite referenco API Primerjajte kanale

Matrika podpore

Kateri kanal sprejme katero vrsto

Kanal v polju capabilities sporoča, kaj sprejema. Pošiljanje vrste, ki je kanal ne podpira, vrne 400 unsupported_message_type in nič se ne zaračuna.

Podpora za vrste sporočil po vrstah kanalov
Vrsta	WhatsApp	SMS	SMS OTP	Telegram	Messenger	Instagram	TikTok
Besedilo`text`	Podprto	Podprto	Podprto	Podprto	Podprto	Podprto	Podprto
Priloge`attachments`	Podprto	Podprto	Ni podprto	Podprto	Podprto	Podprto	Podprto
Predloga`template`	Podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto
Gumbi za odgovor`button`	Podprto	Ni podprto	Ni podprto	Podprto	Podprto	Podprto	Podprto
Seznam`list`	Podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto
Gumb URL`cta_url`	Podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto	Ni podprto
Lokacija`location`	Podprto	Ni podprto	Ni podprto	Podprto	Ni podprto	Ni podprto	Ni podprto
Stiki`contacts`	Podprto	Ni podprto	Ni podprto	Podprto	Ni podprto	Ni podprto	Ni podprto
Anketa`poll`	Ni podprto	Ni podprto	Ni podprto	Podprto	Ni podprto	Ni podprto	Ni podprto

type: "text"

Besedilo

Navadno besedilo, ki ga sprejme vsaka vrsta kanala. Nastavite preview_url, da kanal prikaže predogled povezave.

body: od 1 do 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še naročilo #1042 je odposlano. Spremljajte ga na https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}

type: "attachments"

Priloge

En medijski element na sporočilo, naveden z naslovom URL https: slika, videoposnetek, dokument, zvočni posnetek, glasovno sporočilo ali nalepka, z neobveznim napisom.

Natanko en element. caption: do 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": "Vaš račun za naročilo #1042."
    }
  ]
}

type: "template"

Predloga

Odobrena predloga WhatsApp s spremenljivkami. Predloge so edina sporočila, ki jih WhatsApp sprejme zunaj 24-urnega okna za podporo strankam.

name in language se morata ujemati z odobreno predlogo kanala.

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

type: "button"

Gumbi za odgovor

Sporočilo z največ tremi hitrimi odgovori. ID gumba, ki se ga prejemnik dotakne, se vrne na vaš webhook v dogodku message.received.

Od 1 do 3 gumbi. title: do 20 znakov.

WhatsApp Business
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Vaša miza za dva je rezervirana za nocoj ob 19:30. Ali še vedno pridete?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Potrdi"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Prestavi termin"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Prekliči rezervacijo"
          }
        }
      ]
    }
  }
}

type: "list"

Seznam

Meni, ki se odpre z enim gumbom, z vrsticami, razvrščenimi v naslovljene razdelke.

action.button: do 20 znakov.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Katera ekipa vam lahko danes pomaga?"
    },
    "action": {
      "button": "Izberite ekipo",
      "sections": [
        {
          "title": "Ekipe",
          "rows": [
            {
              "id": "orders",
              "title": "Naročila",
              "description": "Dostava, vračila blaga in vračila kupnine"
            },
            {
              "id": "billing",
              "title": "Računi in plačila",
              "description": "Računi in načini plačila"
            },
            {
              "id": "technical",
              "title": "Tehnična podpora",
              "description": "Nastavitev in odpravljanje težav"
            }
          ]
        }
      ]
    }
  }
}

type: "cta_url"

Gumb URL

Sporočilo z enim gumbom, ki odpre naslov URL, za strani za sledenje, plačila in povezave za prijavo.

En gumb na sporočilo.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Vaš paket je na poti. Spremljajte ga v realnem času."
    },
    "action": {
      "parameters": {
        "display_text": "Sledi naročilu",
        "url": "https://example.com/t/1042"
      }
    }
  }
}

type: "location"

Lokacija

Oznaka na zemljevidu z imenom in naslovom, ki se odpre v prejemnikovi aplikaciji za zemljevide.

latitude in longitude sta podani v decimalnih stopinjah.

WhatsApp Business
Telegram

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Prevzemno mesto",
    "address": "Sheikh Zayed Road, Dubaj"
  }
}

type: "contacts"

Stiki

Ena ali več vizitk s stiki. Polje se kanalu posreduje nespremenjeno, zato uporablja ponudnikovo obliko zapisa stikov.

Primer prikazuje obliko zapisa stika za WhatsApp.

WhatsApp Business
Telegram

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Služba za podporo",
        "first_name": "Podpora"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}

type: "poll"

Anketa

Izvorna anketa v Telegramu z vprašanjem in naborom možnosti.

Samo Telegram.

POST /v1/messages

{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Kdaj naj vam dostavimo naročilo?",
    "options": [
      "Dopoldne, od 09:00 do 12:00",
      "Popoldne, od 12:00 do 17:00",
      "Zvečer, od 17:00 do 21:00"
    ]
  }
}

Preizkusite vse vrste v peskovniku

Vsak račun ima za vsako vrsto kanala kanal peskovnika. S testnim ključem pošljite katero koli vrsto, ki jo kanal podpira: nič se ne dostavi in nič se ne zaračuna.

Pridobite ključ API Preberite dokumentacijo