Salt la conținut
OmniMessage

Tipuri de mesaje

Nouă tipuri de mesaje, un singur corp de cerere

O cerere de trimitere indică un canal, un destinatar și un tip, cu conținutul sub o cheie care poartă numele tipului. Această pagină prezintă fiecare tip, corpul care îl produce și unde este acceptat.

Deschideți referința APIComparați canalele

Matrice de compatibilitate

Ce canal acceptă ce tip

Un canal raportează ce acceptă în capabilities. Trimiterea unui tip pe care canalul nu îl acceptă returnează 400 unsupported_message_type și nu se taxează nimic.

Compatibilitatea tipurilor de mesaje pe tipuri de canale
TipWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
TexttextAcceptatAcceptatAcceptatAcceptatAcceptatAcceptatAcceptat
AtașamenteattachmentsAcceptatAcceptatNeacceptatAcceptatAcceptatAcceptatAcceptat
ȘablontemplateAcceptatNeacceptatNeacceptatNeacceptatNeacceptatNeacceptatNeacceptat
Butoane de răspunsbuttonAcceptatNeacceptatNeacceptatAcceptatAcceptatAcceptatAcceptat
ListălistAcceptatNeacceptatNeacceptatNeacceptatNeacceptatNeacceptatNeacceptat
Buton URLcta_urlAcceptatNeacceptatNeacceptatNeacceptatNeacceptatNeacceptatNeacceptat
LocațielocationAcceptatNeacceptatNeacceptatAcceptatNeacceptatNeacceptatNeacceptat
ContactecontactsAcceptatNeacceptatNeacceptatAcceptatNeacceptatNeacceptatNeacceptat
SondajpollNeacceptatNeacceptatNeacceptatAcceptatNeacceptatNeacceptatNeacceptat
type: "text"

Text

Text simplu, acceptat de toate tipurile de canale. Setați preview_url pentru a permite canalului să afișeze o previzualizare a linkului.

body: între 1 și 4096 de caractere.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Comanda dvs. #1042 a fost expediată. O puteți urmări la https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Atașamente

Un singur element media per mesaj, indicat printr-un URL https: imagine, video, document, audio, mesaj vocal sau sticker, cu o descriere opțională.

Exact un element. caption: până la 1024 de caractere.

  • 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": "Chitanța pentru comanda #1042."
    }
  ]
}
type: "template"

Șablon

Un șablon WhatsApp aprobat, cu variabile. Șabloanele sunt singurele mesaje pe care WhatsApp le acceptă în afara ferestrei de 24 de ore pentru asistența clienților.

name și language trebuie să corespundă unui șablon aprobat al canalului.

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

Butoane de răspuns

Un mesaj cu cel mult trei răspunsuri rapide. ID-ul butonului apăsat ajunge înapoi la webhookul dvs. într-un eveniment message.received.

Între 1 și 3 butoane. title: până la 20 de caractere.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Masa dvs. pentru două persoane este rezervată în această seară, la 19:30. Mai puteți ajunge?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Confirm"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Reprogramez"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Anulez rezervarea"
          }
        }
      ]
    }
  }
}
type: "list"

Listă

Un meniu care se deschide dintr-un singur buton, cu rânduri grupate în secțiuni cu titlu.

action.button: până la 20 de caractere.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Ce echipă vă poate ajuta astăzi?"
    },
    "action": {
      "button": "Alegeți o echipă",
      "sections": [
        {
          "title": "Echipe",
          "rows": [
            {
              "id": "orders",
              "title": "Comenzi",
              "description": "Livrare, retururi și rambursări"
            },
            {
              "id": "billing",
              "title": "Facturare",
              "description": "Facturi și metode de plată"
            },
            {
              "id": "technical",
              "title": "Asistență tehnică",
              "description": "Configurare și depanare"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

Buton URL

Un mesaj cu un singur buton care deschide un URL, pentru pagini de urmărire, plăți și linkuri de autentificare.

Un singur buton per mesaj.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Coletul dvs. este pe drum. Urmăriți-l în timp real."
    },
    "action": {
      "parameters": {
        "display_text": "Urmăriți comanda",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Locație

Un reper cu nume și adresă, care se deschide în aplicația de hărți a destinatarului.

latitude și longitude sunt exprimate în grade zecimale.

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

Contacte

Una sau mai multe cărți de vizită. Tabloul este transmis canalului ca atare, deci folosește formatul de contact al furnizorului.

Exemplul arată formatul de contact WhatsApp.

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

Sondaj

Un sondaj nativ Telegram, cu o întrebare și un set de opțiuni.

Doar pe Telegram.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Când să vă livrăm comanda?",
    "options": [
      "Dimineața, între 09:00 și 12:00",
      "După-amiaza, între 12:00 și 17:00",
      "Seara, între 17:00 și 21:00"
    ]
  }
}

Încercați toate tipurile în sandbox

Fiecare cont are câte un canal sandbox pentru fiecare tip de canal. Trimiteți cu o cheie de test orice tip acceptat de acesta, iar nimic nu este livrat sau facturat.

Obțineți o cheie APICitiți documentația