Skip to main content

@wildix/classound-client > SendWhatsAppInteractiveMessageCommand

SendWhatsAppInteractiveMessageCommand class​

Signature:

export declare class SendWhatsAppInteractiveMessageCommand extends SendWhatsAppInteractiveMessageCommand_base

Extends: SendWhatsAppInteractiveMessageCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { ClassoundClient, SendWhatsAppInteractiveMessageCommand } from "@wildix/classound-client"; // ES Modules import
// const { ClassoundClient, SendWhatsAppInteractiveMessageCommand } = require("@wildix/classound-client"); // CommonJS import
const client = new ClassoundClient(config);
const input = { // SendWhatsAppInteractiveMessageInput
  from: "STRING_VALUE", // required
  to: "STRING_VALUE", // required
  pbx: "STRING_VALUE", // required
  company: "STRING_VALUE", // required
  message: { // InteractiveMessage
    type: "interactive", // required
    interactive: { // InteractiveContent
      type: "list" || "button", // required
      header: { // InteractiveHeader
        type: "text" || "image", // required
        text: "STRING_VALUE", // required
        image: { // InteractiveMedia
          id: "STRING_VALUE", // required
          link: "STRING_VALUE", // required
          filename: "STRING_VALUE",
        },
        video: {
          id: "STRING_VALUE", // required
          link: "STRING_VALUE", // required
          filename: "STRING_VALUE",
        },
        document: {
          id: "STRING_VALUE", // required
          link: "STRING_VALUE", // required
          filename: "STRING_VALUE",
        },
      },
      body: { // InteractiveBody
        type: "text", // required
        text: "STRING_VALUE", // required
      },
      footer: { // InteractiveFooter
        type: "text", // required
        text: "STRING_VALUE", // required
      },
      action: { // InteractiveAction
        type: "button" || "list", // required
        buttons: [ // InteractiveButtonList
          { // InteractiveButton
            type: "reply", // required
            reply: { // InteractiveButtonReply
              id: "STRING_VALUE", // required
              title: "STRING_VALUE", // required
            },
          },
        ],
        sections: [ // InteractiveSectionList
          { // InteractiveSection
            title: "STRING_VALUE", // required
            rows: [ // InteractiveRowList // required
              { // InteractiveRow
                id: "STRING_VALUE", // required
                title: "STRING_VALUE", // required
                description: "STRING_VALUE",
              },
            ],
          },
        ],
      },
    },
  },
  extension: "STRING_VALUE", // required
};
const command = new SendWhatsAppInteractiveMessageCommand(input);
const response = await client.send(command);
// { // SendWhatsAppInteractiveMessageOutput
//   type: "STRING_VALUE",
//   success: true || false,
//   company: "STRING_VALUE",
//   status: "STRING_VALUE",
//   id: [ // StringList
//     "STRING_VALUE",
//   ],
//   data: { // SendWhatsAppInteractiveMessageData
//     from: "STRING_VALUE",
//     to: "STRING_VALUE",
//     pbx: "STRING_VALUE",
//     company: "STRING_VALUE",
//     message: { // InteractiveMessage
//       type: "interactive", // required
//       interactive: { // InteractiveContent
//         type: "list" || "button", // required
//         header: { // InteractiveHeader
//           type: "text" || "image", // required
//           text: "STRING_VALUE", // required
//           image: { // InteractiveMedia
//             id: "STRING_VALUE", // required
//             link: "STRING_VALUE", // required
//             filename: "STRING_VALUE",
//           },
//           video: {
//             id: "STRING_VALUE", // required
//             link: "STRING_VALUE", // required
//             filename: "STRING_VALUE",
//           },
//           document: {
//             id: "STRING_VALUE", // required
//             link: "STRING_VALUE", // required
//             filename: "STRING_VALUE",
//           },
//         },
//         body: { // InteractiveBody
//           type: "text", // required
//           text: "STRING_VALUE", // required
//         },
//         footer: { // InteractiveFooter
//           type: "text", // required
//           text: "STRING_VALUE", // required
//         },
//         action: { // InteractiveAction
//           type: "button" || "list", // required
//           buttons: [ // InteractiveButtonList
//             { // InteractiveButton
//               type: "reply", // required
//               reply: { // InteractiveButtonReply
//                 id: "STRING_VALUE", // required
//                 title: "STRING_VALUE", // required
//               },
//             },
//           ],
//           sections: [ // InteractiveSectionList
//             { // InteractiveSection
//               title: "STRING_VALUE", // required
//               rows: [ // InteractiveRowList // required
//                 { // InteractiveRow
//                   id: "STRING_VALUE", // required
//                   title: "STRING_VALUE", // required
//                   description: "STRING_VALUE",
//                 },
//               ],
//             },
//           ],
//         },
//       },
//     },
//     extension: "STRING_VALUE",
//   },
// };