Beskedtyper

Ni beskedtyper, én anmodnings-body

En afsendelsesanmodning angiver en kanal, en modtager og en type, og indholdet ligger under en nøgle med typens navn. Denne side viser hver type, den body, der giver den, og hvor den understøttes.

Åbn API-referencen Sammenlign kanaler

Supportmatrix

Hvilken kanal accepterer hvilken type

En kanal oplyser, hvad den accepterer, i capabilities. Hvis du sender en type, som kanalen ikke understøtter, returneres 400 unsupported_message_type, og der opkræves ikke noget.

Understøttelse af beskedtyper pr. kanaltype
Type	WhatsApp	SMS	SMS OTP	Telegram	Messenger	Instagram	TikTok
Tekst`text`	Understøttet	Understøttet	Understøttet	Understøttet	Understøttet	Understøttet	Understøttet
Vedhæftninger`attachments`	Understøttet	Understøttet	Ikke understøttet	Understøttet	Understøttet	Understøttet	Understøttet
Skabelon`template`	Understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet
Svarknapper`button`	Understøttet	Ikke understøttet	Ikke understøttet	Understøttet	Understøttet	Understøttet	Understøttet
Liste`list`	Understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet
URL-knap`cta_url`	Understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet
Placering`location`	Understøttet	Ikke understøttet	Ikke understøttet	Understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet
Kontakter`contacts`	Understøttet	Ikke understøttet	Ikke understøttet	Understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet
Afstemning`poll`	Ikke understøttet	Ikke understøttet	Ikke understøttet	Understøttet	Ikke understøttet	Ikke understøttet	Ikke understøttet

type: "text"

Tekst

Ren tekst, som accepteres af alle kanaltyper. Sæt preview_url for at lade kanalen vise en linkforhåndsvisning.

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": "Din ordre #1042 er afsendt. Følg den på https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}

type: "attachments"

Vedhæftninger

Ét medieelement pr. besked, angivet med en https-URL: billede, video, dokument, lyd, talebesked eller klistermærke, med en valgfri billedtekst.

Præcis ét element. caption: op til 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": "Din kvittering for ordre #1042."
    }
  ]
}

type: "template"

Skabelon

En godkendt WhatsApp-skabelon med variabler. Skabeloner er de eneste beskeder, WhatsApp accepterer uden for kundeservicevinduet på 24 timer.

name og language skal svare til en af kanalens godkendte skabeloner.

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

type: "button"

Svarknapper

En besked med op til tre hurtige svar. Id’et for den knap, der trykkes på, kommer tilbage til din webhook i en message.received-hændelse.

1 til 3 knapper. title: op til 20 tegn.

WhatsApp Business
Telegram
Messenger
Instagram
TikTok

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Dit bord til to er reserveret til kl. 19:30 i aften. Kan du stadig nå det?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Bekræft"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Flyt tidspunkt"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Afbestil"
          }
        }
      ]
    }
  }
}

type: "list"

Liste

En menu, der åbnes fra en enkelt knap, med rækker grupperet i afsnit med overskrifter.

action.button: op til 20 tegn.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Hvilket team kan hjælpe dig i dag?"
    },
    "action": {
      "button": "Vælg et team",
      "sections": [
        {
          "title": "Teams",
          "rows": [
            {
              "id": "orders",
              "title": "Ordrer",
              "description": "Levering, returnering og refundering"
            },
            {
              "id": "billing",
              "title": "Fakturering",
              "description": "Fakturaer og betalingsmetoder"
            },
            {
              "id": "technical",
              "title": "Teknisk support",
              "description": "Opsætning og fejlfinding"
            }
          ]
        }
      ]
    }
  }
}

type: "cta_url"

URL-knap

En besked med én knap, der åbner en URL, til sporingssider, betalinger og loginlinks.

Én knap pr. besked.

WhatsApp Business

POST /v1/messages

{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Din pakke er på vej. Følg den i realtid."
    },
    "action": {
      "parameters": {
        "display_text": "Spor ordre",
        "url": "https://example.com/t/1042"
      }
    }
  }
}

type: "location"

Placering

En kortnål med navn og adresse, som åbnes i modtagerens kortapp.

latitude og longitude er decimalgrader.

WhatsApp Business
Telegram

POST /v1/messages

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

type: "contacts"

Kontakter

Et eller flere kontaktkort. Arrayet sendes uændret videre til kanalen, så det bruger udbyderens eget kontaktformat.

Eksemplet viser WhatsApps kontaktformat.

WhatsApp Business
Telegram

POST /v1/messages

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

type: "poll"

Afstemning

En indbygget Telegram-afstemning med et spørgsmål og en række svarmuligheder.

Kun Telegram.

POST /v1/messages

{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Hvornår skal vi levere din ordre?",
    "options": [
      "Formiddag, 09:00–12:00",
      "Eftermiddag, 12:00–17:00",
      "Aften, 17:00–21:00"
    ]
  }
}

Prøv alle typer i sandboxen

Hver konto har en sandbox-kanal for hver kanaltype. Send en hvilken som helst type, den understøtter, med en testnøgle, uden at noget bliver leveret eller faktureret.

Få en API-nøgle Læs dokumentationen