Meldingstyper

Ni meldingstyper, ett forespørselsformat

En sendeforespørsel angir en kanal, en mottaker og en type, med innholdet under en nøkkel som heter det samme som typen. Denne siden viser hver type, forespørselsinnholdet som gir den, og hvor den støttes.

Åpne API-referansen Sammenlign kanaler

Støttematrise

Hvilken kanal godtar hvilken type

En kanal oppgir hva den godtar, i capabilities. Hvis du sender en type som kanalen ikke støtter, returneres 400 unsupported_message_type, og ingenting belastes.

Støtte for meldingstyper per kanaltype
Type	WhatsApp	SMS	SMS OTP	Telegram	Messenger	Instagram	TikTok
Tekst`text`	Støttes	Støttes	Støttes	Støttes	Støttes	Støttes	Støttes
Vedlegg`attachments`	Støttes	Støttes	Støttes ikke	Støttes	Støttes	Støttes	Støttes
Mal`template`	Støttes	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke
Svarknapper`button`	Støttes	Støttes ikke	Støttes ikke	Støttes	Støttes	Støttes	Støttes
Liste`list`	Støttes	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke
URL-knapp`cta_url`	Støttes	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke	Støttes ikke
Posisjon`location`	Støttes	Støttes ikke	Støttes ikke	Støttes	Støttes ikke	Støttes ikke	Støttes ikke
Kontakter`contacts`	Støttes	Støttes ikke	Støttes ikke	Støttes	Støttes ikke	Støttes ikke	Støttes ikke
Avstemning`poll`	Støttes ikke	Støttes ikke	Støttes ikke	Støttes	Støttes ikke	Støttes ikke	Støttes ikke

type: "text"

Tekst

Ren tekst, som alle kanaltyper godtar. Angi preview_url hvis kanalen skal vise en forhåndsvisning av lenken.

body: 1 til 4 096 tegn.

WhatsApp Business
SMS
SMS OTP
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Bestillingen din #1042 er sendt. Følg den på https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}

type: "attachments"

Vedlegg

Ett medieelement per melding, angitt med en https-URL: bilde, video, dokument, lyd, talemelding eller klistremerke, med en valgfri bildetekst.

Nøyaktig ett element. caption: opptil 1 024 tegn.

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": "Kvitteringen din for bestilling #1042."
    }
  ]
}

type: "template"

Mal

En godkjent WhatsApp-mal med variabler. Maler er de eneste meldingene WhatsApp godtar utenfor kundeservicevinduet på 24 timer.

name og language må samsvare med en av kanalens godkjente maler.

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

type: "button"

Svarknapper

En melding med opptil tre hurtigsvar. ID-en til knappen mottakeren trykker på, kommer tilbake til webhooken din i en message.received-hendelse.

1 til 3 knapper. title: opptil 20 tegn.

WhatsApp Business
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Bordet ditt for to er reservert til 19:30 i kveld. Passer det fortsatt?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Bekreft"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Endre tidspunkt"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Avbestill"
          }
        }
      ]
    }
  }
}

type: "list"

Liste

En meny som åpnes fra én enkelt knapp, med rader gruppert i seksjoner med overskrifter.

action.button: opptil 20 tegn.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Hvilket team kan hjelpe deg i dag?"
    },
    "action": {
      "button": "Velg et team",
      "sections": [
        {
          "title": "Team",
          "rows": [
            {
              "id": "orders",
              "title": "Bestillinger",
              "description": "Levering, returer og refusjoner"
            },
            {
              "id": "billing",
              "title": "Fakturering",
              "description": "Fakturaer og betalingsmåter"
            },
            {
              "id": "technical",
              "title": "Teknisk støtte",
              "description": "Oppsett og feilsøking"
            }
          ]
        }
      ]
    }
  }
}

type: "cta_url"

URL-knapp

En melding med én knapp som åpner en URL, for sporingssider, betalinger og innloggingslenker.

Én knapp per melding.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Pakken din er på vei. Følg den i sanntid."
    },
    "action": {
      "parameters": {
        "display_text": "Spor bestillingen",
        "url": "https://example.com/t/1042"
      }
    }
  }
}

type: "location"

Posisjon

En kartnål med et navn og en adresse som åpnes i mottakerens kartapp.

latitude og longitude angis i desimalgrader.

WhatsApp Business
Telegram

POST /v1/messages

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

type: "contacts"

Kontakter

Ett eller flere kontaktkort. Arrayen videresendes til kanalen som den er, så den bruker leverandørens eget kontaktformat.

Eksempelet viser kontaktformatet til WhatsApp.

WhatsApp Business
Telegram

POST /v1/messages

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

type: "poll"

Avstemning

En innebygd Telegram-avstemning med et spørsmål og et sett med svaralternativer.

Bare Telegram.

POST /v1/messages

{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Når skal vi levere bestillingen din?",
    "options": [
      "Formiddag, 09:00 til 12:00",
      "Ettermiddag, 12:00 til 17:00",
      "Kveld, 17:00 til 21:00"
    ]
  }
}

Prøv alle typene i sandkassen

Hver konto har en sandkassekanal for hver kanaltype. Send en hvilken som helst type kanalen støtter, med en testnøkkel, så blir ingenting levert eller belastet.

Skaff en API-nøkkel Les dokumentasjonen