Zum Inhalt springen
OmniMessage

Nachrichtentypen

Neun Nachrichtentypen, ein Request-Body

Eine Sendeanfrage nennt einen Kanal, einen Empfänger und einen Typ; der Inhalt steht unter einem Schlüssel, der wie der Typ heißt. Diese Seite zeigt jeden Typ, den Body, der ihn erzeugt, und wo er unterstützt wird.

API-Referenz öffnenKanäle vergleichen

Support-Matrix

Welcher Kanal welchen Typ akzeptiert

Ein Kanal meldet in capabilities, was er akzeptiert. Wird ein Typ gesendet, den ein Kanal nicht unterstützt, lautet die Antwort 400 unsupported_message_type, und es wird nichts berechnet.

Unterstützung der Nachrichtentypen nach Kanaltyp
TypWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
TexttextUnterstütztUnterstütztUnterstütztUnterstütztUnterstütztUnterstütztUnterstützt
AnhängeattachmentsUnterstütztUnterstütztNicht unterstütztUnterstütztUnterstütztUnterstütztUnterstützt
VorlagetemplateUnterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstützt
Antwort-ButtonsbuttonUnterstütztNicht unterstütztNicht unterstütztUnterstütztUnterstütztUnterstütztUnterstützt
ListelistUnterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstützt
URL-Buttoncta_urlUnterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstütztNicht unterstützt
StandortlocationUnterstütztNicht unterstütztNicht unterstütztUnterstütztNicht unterstütztNicht unterstütztNicht unterstützt
KontaktecontactsUnterstütztNicht unterstütztNicht unterstütztUnterstütztNicht unterstütztNicht unterstütztNicht unterstützt
UmfragepollNicht unterstütztNicht unterstütztNicht unterstütztUnterstütztNicht unterstütztNicht unterstütztNicht unterstützt
type: "text"

Text

Reiner Text, den jeder Kanaltyp akzeptiert. Setzen Sie preview_url, damit der Kanal eine Linkvorschau anzeigt.

body: 1 bis 4.096 Zeichen.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Ihre Bestellung #1042 wurde versandt. Verfolgen Sie sie unter https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Anhänge

Ein Medienelement pro Nachricht, referenziert über eine https-URL: Bild, Video, Dokument, Audio, Sprachnachricht oder Sticker, optional mit Bildunterschrift.

Genau ein Element. caption: bis zu 1.024 Zeichen.

  • 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": "Ihr Beleg zur Bestellung #1042."
    }
  ]
}
type: "template"

Vorlage

Eine freigegebene WhatsApp-Vorlage mit Variablen. Vorlagen sind die einzigen Nachrichten, die WhatsApp außerhalb des 24-Stunden-Kundenservicefensters akzeptiert.

name und language müssen einer freigegebenen Vorlage des Kanals entsprechen.

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

Antwort-Buttons

Eine Nachricht mit bis zu drei Schnellantworten. Die ID des angetippten Buttons kommt in einem message.received-Ereignis an Ihren Webhook zurück.

1 bis 3 Buttons. title: bis zu 20 Zeichen.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Ihr Tisch für zwei Personen ist für heute Abend um 19:30 Uhr reserviert. Schaffen Sie es noch?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Bestätigen"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Verschieben"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Stornieren"
          }
        }
      ]
    }
  }
}
type: "list"

Liste

Ein Menü, das sich über einen einzelnen Button öffnet, mit Zeilen in betitelten Abschnitten.

action.button: bis zu 20 Zeichen.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Welches Team kann Ihnen heute weiterhelfen?"
    },
    "action": {
      "button": "Team auswählen",
      "sections": [
        {
          "title": "Teams",
          "rows": [
            {
              "id": "orders",
              "title": "Bestellungen",
              "description": "Lieferung, Rücksendungen und Erstattungen"
            },
            {
              "id": "billing",
              "title": "Abrechnung",
              "description": "Rechnungen und Zahlungsmethoden"
            },
            {
              "id": "technical",
              "title": "Technischer Support",
              "description": "Einrichtung und Fehlerbehebung"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

URL-Button

Eine Nachricht mit einem Button, der eine URL öffnet, für Sendungsverfolgung, Zahlungen und Anmeldelinks.

Ein Button pro Nachricht.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Ihr Paket ist unterwegs. Verfolgen Sie es in Echtzeit."
    },
    "action": {
      "parameters": {
        "display_text": "Sendung verfolgen",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Standort

Eine Markierung mit Name und Adresse, die sich in der Karten-App des Empfängers öffnet.

latitude und longitude werden in Dezimalgrad angegeben.

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

Kontakte

Eine oder mehrere Kontaktkarten. Das Array wird unverändert an den Kanal weitergereicht und verwendet daher das Kontaktformat des jeweiligen Anbieters.

Das Beispiel zeigt das Kontaktformat von WhatsApp.

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

Umfrage

Eine native Telegram-Umfrage mit einer Frage und mehreren Antwortoptionen.

Nur Telegram.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Wann sollen wir Ihre Bestellung liefern?",
    "options": [
      "Vormittags, 09:00 bis 12:00 Uhr",
      "Nachmittags, 12:00 bis 17:00 Uhr",
      "Abends, 17:00 bis 21:00 Uhr"
    ]
  }
}

Alle Typen in der Sandbox ausprobieren

Jedes Konto hat für jeden Kanaltyp einen Sandbox-Kanal. Senden Sie mit einem Testschlüssel jeden unterstützten Typ; nichts wird zugestellt oder abgerechnet.

API-Schlüssel holenDokumentation lesen