Skip to main content

Interactive (INTERACTIVE)

An interactive message with a text body and an optional action button. Usually sent by the bot.

data schema

{
body: string;
footer?: string;
file?: {
url: string;
mime: string;
path: string;
size: number;
fileName: string;
extension: string;
};
replyButtons?: Array<string | { id: string; title: string }>;
actionButton?: {
url: string;
title: string;
};
}
FieldTypeDescription
bodystringMain text (may include line breaks and links)
footerstring?Optional footer
fileobject?Optional top media
replyButtonsarray?Optional quick-reply buttons
actionButtonobject?CTA button that opens an external URL

actionButton

FieldTypeDescription
urlstringTarget URL
titlestringButton text

Example

{
"id": "ff03f52d-0726-43bd-8e19-ae6e7fab521a",
"createdAt": "2026-08-03T14:53:08.486Z",
"type": "INTERACTIVE",
"nameOfSender": "Support Bot",
"isFromSupport": true,
"data": {
"body": "Güzel bir seçim. 🙂 Deluxe Suit Jakuzi ve Şömineli için rezervasyonunuzu tamamlayabilirsiniz.\n\n🔗 Rezervasyon: https://www.tatilbudur.com/...\n\n📱 Mobil uygulama: http://onelink.to/g6ec4p\n\nBaşka yardımcı olabileceğim bir konu var mı?",
"actionButton": {
"url": "https://www.tatilbudur.com/la-bien-alacati-hotel?checkInDate=2026-08-20&checkOutDate=2026-08-25&calculatePrice=1&adult=2",
"title": "Rezervasyon Yap"
}
}
}

UI recommendation

  • Show the body text with line breaks; make URLs clickable.
  • If actionButton is present, render it as an external link button.