Documentation Index
Fetch the complete documentation index at: https://howto.paigeme.dev/llms.txt
Use this file to discover all available pages before exploring further.
Paige bots can send nine types of WhatsApp messages. Each type is a JavaScript function available in your bot’s services/messages.js file. The right message type depends on what you need the user to do: read information, pick from options, share their location, or receive a file. The examples below show the exact function signatures from the template, so you can use them directly in your bot code.
Interactive messages — buttons, list menus, URL buttons, and flows — are billed as “interactive” messages by WhatsApp. Plain text and media messages are billed as regular messages. Check the Meta pricing page for the current rates for your region. Message types
Text
Buttons
URL button
Image
Document
Location request
Voice notes
Templates
Send a plain text message. Supports newlines using \n.await sendText(conversationId, to, "Hello! How can I help you today?");
conversationId — the conversation ID from your databaseto — the recipient’s phone number (e.g. "27821234567")text — the message body; use \n for line breaks
Text messages are the simplest message type and work in all WhatsApp clients. Use them for confirmations, plain responses, and any message that does not need user input. Send up to three quick-reply buttons below a message body. Each button has an id (used in your code logic) and a title (shown to the user).await sendInteractiveButtons(
conversationId,
to,
"What would you like to do?",
[
{ id: "book_demo", title: "Book a demo" },
{ id: "get_support", title: "Get support" },
{ id: "learn_more", title: "Learn more" },
]
);
conversationId — the conversation IDto — recipient phone numberbodyText — the message text shown above the buttonsbuttons — array of up to 3 button objects, each with id and title
When the user taps a button, your webhook receives an interactive message with message.interactive.button_reply.id set to the button’s id. Use that value in your state handler to branch the conversation.Button titles are limited to 20 characters. Button IDs are limited to 256 characters and must be unique per message.
Send a call-to-action button that opens a URL when tapped. Use this for links to web pages, booking portals, payment links, or any external resource.await sendURLButton(
conversationId,
to,
"Your booking is confirmed. View the details below.",
"View booking",
"https://example.com/bookings/abc123"
);
conversationId — the conversation IDto — recipient phone numberbodyText — the message text shown above the buttonbuttonText — the button labelurl — the URL to open
URL buttons open in the in-app browser inside WhatsApp. They do not generate a reply to your webhook when tapped. Send an image with an optional caption. The image must be accessible via a public URL.await sendImage(
conversationId,
to,
"https://example.com/images/product.jpg",
"Our latest model — available now."
);
conversationId — the conversation IDto — recipient phone numberimageUrl — public URL of the image (JPEG or PNG)caption — optional caption displayed below the image
Supported formats are JPEG and PNG. Images must be under 5 MB. If you omit the caption, pass null as the fourth argument. Send a file (PDF or other document type) with a filename and optional caption. The file must be accessible via a public URL.await sendPDF(
conversationId,
to,
"https://example.com/files/invoice.pdf",
"invoice_march_2025.pdf",
"Your invoice for March 2025."
);
conversationId — the conversation IDto — recipient phone numberpdfUrl — public URL of the filefileName — the filename shown to the user (e.g. "invoice.pdf")caption — optional caption shown below the document
Documents appear in WhatsApp with a download button. PDF is the most common format. Files must be under 100 MB. Ask the user to share their location. WhatsApp displays a “Send location” button that opens the native location picker.await sendLocationRequest(
conversationId,
to,
"Please share your location so we can find the nearest branch."
);
conversationId — the conversation IDto — recipient phone numberbodyText — the message text shown above the “Send location” button
When the user shares their location, your webhook receives a location message containing latitude, longitude, and optionally name and address. Access these via message.location.latitude and message.location.longitude. Your bot does not send voice notes, but it can receive and transcribe them. When a user sends a voice note, the AI bot template automatically transcribes the audio to text using OpenAI and passes the transcript into your conversation handler as if it were a plain text message. Your existing state handlers process voice notes without any changes on your part.// Voice notes are handled automatically by the AI bot template.
// The transcript is passed to your state handler as a plain text message.
// No additional code is required on your end.
Voice note transcription requires an OpenAI API key stored as a secret in your project. See Secrets for how to add one. Send a Meta-approved message template to a user who has not messaged you recently (outside the 24-hour window) or for proactive outbound notifications.await sendTemplate(
to,
"appointment_reminder",
"en",
[
{
type: "body",
parameters: [
{ type: "text", text: "Sarah" },
{ type: "text", text: "tomorrow at 3pm" },
],
},
]
);
to — recipient phone numbertemplateName — the approved template namelanguageCode — language code (e.g. "en", "en_US", "es")components — array of component objects with variable values
Templates must be approved by Meta before they can be sent. See Message Templates for how to create and manage them. Carousel messages
You can also send a carousel of up to 10 cards, each with an image, body text, and quick-reply buttons. Carousels are useful for product listings, plan comparisons, or multi-item promotions.
await sendCarousel(
conversationId,
to,
"Here are our current plans:",
[
{
imageUrl: "https://example.com/images/starter.jpg",
bodyText: "Starter — $29/month. Up to 1,000 conversations.",
buttons: [{ id: "plan_starter", title: "Choose Starter" }],
},
{
imageUrl: "https://example.com/images/pro.jpg",
bodyText: "Pro — $79/month. Unlimited conversations.",
buttons: [{ id: "plan_pro", title: "Choose Pro" }],
},
]
);
cards array takes imageUrl, bodyText, and a buttons array. Button clicks are returned via the webhook as interactive messages with button_reply.
Sending a WhatsApp Flow
To open a multi-screen WhatsApp Flow from within a conversation, use sendFlow. The user taps the call-to-action button and the flow opens inline in WhatsApp.
await sendFlow(
conversationId,
to,
{
flow_id: "1234567890",
flow_cta: "Book now",
body_text: "Fill in your details to complete your booking.",
screen: "BOOKING_SCREEN",
}
);