Hoppa till innehållet
OmniMessage

Meddelandetyper

Nio meddelandetyper, ett anropsformat

Ett sändningsanrop anger en kanal, en mottagare och en typ, med innehållet under en nyckel som heter som typen. Den här sidan visar varje typ, det anropsinnehåll som ger upphov till den och var den stöds.

Öppna API-referensenJämför kanaler

Stödmatris

Vilken kanal tar emot vilken typ

En kanal anger vad den tar emot i capabilities. Om du skickar en typ som kanalen inte stöder returneras 400 unsupported_message_type och inget debiteras.

Stöd för meddelandetyper per kanaltyp
TypWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
TexttextStödsStödsStödsStödsStödsStödsStöds
BilagorattachmentsStödsStödsStöds inteStödsStödsStödsStöds
MalltemplateStödsStöds inteStöds inteStöds inteStöds inteStöds inteStöds inte
SvarsknapparbuttonStödsStöds inteStöds inteStödsStödsStödsStöds
ListalistStödsStöds inteStöds inteStöds inteStöds inteStöds inteStöds inte
URL-knappcta_urlStödsStöds inteStöds inteStöds inteStöds inteStöds inteStöds inte
PlatslocationStödsStöds inteStöds inteStödsStöds inteStöds inteStöds inte
KontaktercontactsStödsStöds inteStöds inteStödsStöds inteStöds inteStöds inte
OmröstningpollStöds inteStöds inteStöds inteStödsStöds inteStöds inteStöds inte
type: "text"

Text

Ren text, som alla kanaltyper tar emot. Ange preview_url om kanalen ska visa en länkförhandsvisning.

body: 1 till 4 096 tecken.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Din beställning #1042 har skickats. Följ den på https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Bilagor

Ett medieobjekt per meddelande, som anges med en https-URL: bild, video, dokument, ljud, röstmeddelande eller klistermärke, med en valfri bildtext.

Exakt ett objekt. caption: upp till 1 024 tecken.

  • 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": "Ditt kvitto för beställning #1042."
    }
  ]
}
type: "template"

Mall

En godkänd WhatsApp-mall med variabler. Mallar är de enda meddelanden som WhatsApp accepterar utanför kundtjänstfönstret på 24 timmar.

name och language måste motsvara en av kanalens godkända mallar.

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

Svarsknappar

Ett meddelande med upp till tre snabbsvar. ID:t för den knapp som mottagaren trycker på kommer tillbaka till din webhook i en message.received-händelse.

1 till 3 knappar. title: upp till 20 tecken.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Ditt bord för två är bokat till 19:30 i kväll. Passar tiden fortfarande?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Bekräfta"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Boka om"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Avboka"
          }
        }
      ]
    }
  }
}
type: "list"

Lista

En meny som öppnas från en enda knapp, med rader grupperade i avsnitt med rubriker.

action.button: upp till 20 tecken.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Vilket team kan hjälpa dig i dag?"
    },
    "action": {
      "button": "Välj ett team",
      "sections": [
        {
          "title": "Team",
          "rows": [
            {
              "id": "orders",
              "title": "Beställningar",
              "description": "Leverans, returer och återbetalningar"
            },
            {
              "id": "billing",
              "title": "Fakturering",
              "description": "Fakturor och betalningssätt"
            },
            {
              "id": "technical",
              "title": "Teknisk support",
              "description": "Installation och felsökning"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

URL-knapp

Ett meddelande med en knapp som öppnar en URL, för spårningssidor, betalningar och inloggningslänkar.

En knapp per meddelande.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Ditt paket är på väg. Följ det i realtid."
    },
    "action": {
      "parameters": {
        "display_text": "Spåra beställningen",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Plats

En kartnål med ett namn och en adress som öppnas i mottagarens kartapp.

latitude och longitude anges i decimalgrader.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Utlämningsställe",
    "address": "Sheikh Zayed Road, Dubai"
  }
}
type: "contacts"

Kontakter

Ett eller flera kontaktkort. Arrayen vidarebefordras till kanalen som den är, så den använder leverantörens eget kontaktformat.

Exemplet visar WhatsApps kontaktformat.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Kundtjänst",
        "first_name": "Kundtjänst"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}
type: "poll"

Omröstning

En inbyggd Telegram-omröstning med en fråga och ett antal svarsalternativ.

Endast Telegram.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "När ska vi leverera din beställning?",
    "options": [
      "Förmiddag, 09:00 till 12:00",
      "Eftermiddag, 12:00 till 17:00",
      "Kväll, 17:00 till 21:00"
    ]
  }
}

Prova alla typer i sandlådan

Varje konto har en sandlådekanal för varje kanaltyp. Skicka vilken typ som helst som kanalen stöder med en testnyckel, så levereras eller debiteras ingenting.

Skaffa en API-nyckelLäs dokumentationen