Viestityypit

Yhdeksän viestityyppiä, yksi pyynnön runko

Lähetyspyyntö nimeää kanavan, vastaanottajan ja tyypin, ja sisältö on tyypin mukaan nimetyn avaimen alla. Tällä sivulla näet jokaisen tyypin, sen tuottavan rungon ja sen, missä tyyppiä tuetaan.

Avaa API-viite Vertaile kanavia

Tukimatriisi

Mikä kanava hyväksyy minkä tyypin

Kanava ilmoittaa hyväksymänsä tyypit kentässä capabilities. Jos lähetät tyypin, jota kanava ei tue, vastaus on 400 unsupported_message_type eikä mitään veloiteta.

Viestityyppien tuki kanavatyypeittäin
Tyyppi	WhatsApp	SMS	SMS OTP	Telegram	Messenger	Instagram	TikTok
Teksti`text`	Tuettu	Tuettu	Tuettu	Tuettu	Tuettu	Tuettu	Tuettu
Liitteet`attachments`	Tuettu	Tuettu	Ei tuettu	Tuettu	Tuettu	Tuettu	Tuettu
Viestipohja`template`	Tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu
Vastauspainikkeet`button`	Tuettu	Ei tuettu	Ei tuettu	Tuettu	Tuettu	Tuettu	Tuettu
Luettelo`list`	Tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu
URL-painike`cta_url`	Tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu	Ei tuettu
Sijainti`location`	Tuettu	Ei tuettu	Ei tuettu	Tuettu	Ei tuettu	Ei tuettu	Ei tuettu
Yhteystiedot`contacts`	Tuettu	Ei tuettu	Ei tuettu	Tuettu	Ei tuettu	Ei tuettu	Ei tuettu
Kysely`poll`	Ei tuettu	Ei tuettu	Ei tuettu	Tuettu	Ei tuettu	Ei tuettu	Ei tuettu

type: "text"

Teksti

Pelkkä teksti, jonka jokainen kanavatyyppi hyväksyy. Aseta preview_url, niin kanava näyttää linkin esikatselun.

body: 1–4 096 merkkiä.

WhatsApp Business
SMS
SMS OTP
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Tilauksesi #1042 on lähetetty. Seuraa sitä osoitteessa https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}

type: "attachments"

Liitteet

Yksi mediakohde viestiä kohden https-URL-osoitteella viitattuna: kuva, video, asiakirja, ääni, ääniviesti tai tarra, halutessasi kuvatekstin kera.

Täsmälleen yksi kohde. caption: enintään 1 024 merkkiä.

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": "Kuittisi tilauksesta #1042."
    }
  ]
}

type: "template"

Viestipohja

Hyväksytty WhatsApp-viestipohja muuttujineen. Viestipohjat ovat ainoita viestejä, jotka WhatsApp hyväksyy 24 tunnin asiakaspalveluikkunan ulkopuolella.

Kenttien name ja language on vastattava kanavan hyväksyttyä viestipohjaa.

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

type: "button"

Vastauspainikkeet

Viesti, jossa on enintään kolme pikavastausta. Napautetun painikkeen tunniste palautuu webhookiisi message.received-tapahtumassa.

1–3 painiketta. title: enintään 20 merkkiä.

WhatsApp Business
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Kahden hengen pöytänne on varattu täksi illaksi klo 19.30. Pääsettehän paikalle?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Vahvista"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Siirrä aikaa"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Peru varaus"
          }
        }
      ]
    }
  }
}

type: "list"

Luettelo

Yhdestä painikkeesta avautuva valikko, jonka rivit on ryhmitelty otsikoituihin osioihin.

action.button: enintään 20 merkkiä.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Mikä tiimi voi auttaa sinua tänään?"
    },
    "action": {
      "button": "Valitse tiimi",
      "sections": [
        {
          "title": "Tiimit",
          "rows": [
            {
              "id": "orders",
              "title": "Tilaukset",
              "description": "Toimitus, palautukset ja hyvitykset"
            },
            {
              "id": "billing",
              "title": "Laskutus",
              "description": "Laskut ja maksutavat"
            },
            {
              "id": "technical",
              "title": "Tekninen tuki",
              "description": "Käyttöönotto ja vianmääritys"
            }
          ]
        }
      ]
    }
  }
}

type: "cta_url"

URL-painike

Viesti, jossa on yksi URL-osoitteen avaava painike: seurantasivuille, maksuihin ja kirjautumislinkkeihin.

Yksi painike viestiä kohden.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Pakettisi on matkalla. Seuraa sitä reaaliajassa."
    },
    "action": {
      "parameters": {
        "display_text": "Seuraa tilausta",
        "url": "https://example.com/t/1042"
      }
    }
  }
}

type: "location"

Sijainti

Karttamerkki nimellä ja osoitteella; avautuu vastaanottajan karttasovelluksessa.

latitude ja longitude annetaan desimaaliasteina.

WhatsApp Business
Telegram

POST /v1/messages

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

type: "contacts"

Yhteystiedot

Yksi tai useampi yhteystietokortti. Taulukko välitetään kanavalle sellaisenaan, joten se noudattaa palveluntarjoajan omaa yhteystietomuotoa.

Esimerkissä on WhatsAppin yhteystietomuoto.

WhatsApp Business
Telegram

POST /v1/messages

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

type: "poll"

Kysely

Telegramin oma kysely, jossa on kysymys ja joukko vaihtoehtoja.

Vain Telegram.

POST /v1/messages

{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Milloin toimitamme tilauksesi?",
    "options": [
      "Aamupäivä, klo 9.00–12.00",
      "Iltapäivä, klo 12.00–17.00",
      "Ilta, klo 17.00–21.00"
    ]
  }
}

Kokeile jokaista tyyppiä hiekkalaatikossa

Jokaisella tilillä on hiekkalaatikkokanava kutakin kanavatyyppiä varten. Lähetä testiavaimella mitä tahansa sen tukemaa tyyppiä – mitään ei toimiteta eikä laskuteta.

Hanki API-avain Lue dokumentaatio