Text with Buttons

api docs

The sendTextWithButtons function allows you to send a text message with multiple buttons to a WhatsApp number.

async function sendTextWithButtons({
  to,
  message,
  config,
}: {
  to: string;
  message: {
    text: string;
    buttons: Array<{
      title: string;
      id: string;
    }>;
  };
  config?: WsConfig;
}): Promise<SendMessageResponse>;

NOTE

Support for header and footer coming soon.

IMPORTANT

Max 3 buttons for message

Max 20 char for button text

Parameters:

• to: The WhatsApp phone number recipient, including country code.
• message.text: The main text message content.
• message.buttons: An array of buttons, where each button has a title and an id.
• config: Optional configuration settings.

Return

• Success: True for success, false for fail.
• Response: Information about the message sent, like the message ID, delivery status, and more.

Limitations

• Body text: 1024 characters
• Button ID: 256 characters
• Button text: 20 characters
• Max buttons: 3

Example usage

import { sendTextWithButtons } from "ws-cloud-api/messaging";

sendTextWithButtons({
  to: "573123456789",
  message: {
    text: "This is a test message with buttons",
    buttons: [
      {
        title: "Button 1",
        id: "1",
      },
      {
        title: "Button 2",
        id: "2",
      },
    ],
  },
})
  .then((response) => {
    if (response.success) {
      console.log("Message with buttons sent");
    }
  })
  .catch(console.error);