Skip to main content

@wildix/xbees-conversations-client > SendMessageCommand

SendMessageCommand class​

Sends a message to a specified channel. This operation requires the channel to be accessible to the user.

Signature:

export declare class SendMessageCommand extends SendMessageCommand_base

Extends: SendMessageCommand_base

Example​

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

import { ConversationsClient, SendMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, SendMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // SendMessageInput
  text: "STRING_VALUE",
  elements: [ // ElementsList
    { // Element Union: only one key present
      actions: [ // ActionsElementsList
        { // ActionElement Union: only one key present
          button: { // ButtonElement
            text: "STRING_VALUE", // required
            variant: "contained" || "outlined",
            disabled: true || false,
            handler: { // ButtonHandler Union: only one key present
              link: { // ButtonLinkHandler
                url: "STRING_VALUE", // required
              },
              reply: { // ButtonReplyHandler
                text: "STRING_VALUE",
              },
              action: { // ButtonActionHandler
                id: "STRING_VALUE", // required
              },
            },
          },
        },
      ],
    },
  ],
  attachments: [ // MessageAttachmentList
    { // MessageAttachment
      id: "STRING_VALUE", // required
      fsId: "STRING_VALUE", // required
      mime: "STRING_VALUE",
      name: "STRING_VALUE", // required
      size: Number("int"), // required
      width: Number("int"),
      height: Number("int"),
      thumbnail: "STRING_VALUE",
    },
  ],
  quote: { // MessageQuote
    messageId: "STRING_VALUE", // required
    channelId: "STRING_VALUE", // required
    user: { // User
      id: "STRING_VALUE", // required
      name: "STRING_VALUE",
      email: "STRING_VALUE",
      phone: "STRING_VALUE",
      picture: "STRING_VALUE",
      locale: "STRING_VALUE",
      timeZone: "STRING_VALUE",
      company: "STRING_VALUE",
      bot: true || false,
      pbxDomain: "STRING_VALUE",
      pbxPort: "STRING_VALUE",
      pbxExtension: "STRING_VALUE",
      pbxSerial: "STRING_VALUE",
      pbxUserId: "STRING_VALUE",
      createdAt: "STRING_VALUE",
      updatedAt: "STRING_VALUE",
    },
    text: "STRING_VALUE",
    attachments: [
      {
        id: "STRING_VALUE", // required
        fsId: "STRING_VALUE", // required
        mime: "STRING_VALUE",
        name: "STRING_VALUE", // required
        size: Number("int"), // required
        width: Number("int"),
        height: Number("int"),
        thumbnail: "STRING_VALUE",
      },
    ],
    forward: { // MessageForward
      forwardCompany: "STRING_VALUE",
      forwardDate: "STRING_VALUE", // required
      forwardEmail: "STRING_VALUE",
      forwardName: "STRING_VALUE",
      messageId: "STRING_VALUE", // required
      channelId: "STRING_VALUE", // required
    },
    mentions: [ // UsersList
      {
        id: "STRING_VALUE", // required
        name: "STRING_VALUE",
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        picture: "STRING_VALUE",
        locale: "STRING_VALUE",
        timeZone: "STRING_VALUE",
        company: "STRING_VALUE",
        bot: true || false,
        pbxDomain: "STRING_VALUE",
        pbxPort: "STRING_VALUE",
        pbxExtension: "STRING_VALUE",
        pbxSerial: "STRING_VALUE",
        pbxUserId: "STRING_VALUE",
        createdAt: "STRING_VALUE",
        updatedAt: "STRING_VALUE",
      },
    ],
    giphy: { // MessageGiphy
      id: "STRING_VALUE", // required
      size: "STRING_VALUE", // required
      url: "STRING_VALUE", // required
      height: "STRING_VALUE", // required
      width: "STRING_VALUE", // required
    },
    createdAt: "STRING_VALUE", // required
    updatedAt: "STRING_VALUE",
  },
  forward: {
    forwardCompany: "STRING_VALUE",
    forwardDate: "STRING_VALUE", // required
    forwardEmail: "STRING_VALUE",
    forwardName: "STRING_VALUE",
    messageId: "STRING_VALUE", // required
    channelId: "STRING_VALUE", // required
  },
  channelId: "STRING_VALUE", // required
  userId: "STRING_VALUE",
  messageId: "STRING_VALUE",
  mentions: [ // UsersIdList
    "STRING_VALUE",
  ],
};
const command = new SendMessageCommand(input);
const response = await client.send(command);
// { // SendMessageOutput
//   message: { // Message
//     text: "STRING_VALUE",
//     elements: [ // ElementsList
//       { // Element Union: only one key present
//         actions: [ // ActionsElementsList
//           { // ActionElement Union: only one key present
//             button: { // ButtonElement
//               text: "STRING_VALUE", // required
//               variant: "contained" || "outlined",
//               disabled: true || false,
//               handler: { // ButtonHandler Union: only one key present
//                 link: { // ButtonLinkHandler
//                   url: "STRING_VALUE", // required
//                 },
//                 reply: { // ButtonReplyHandler
//                   text: "STRING_VALUE",
//                 },
//                 action: { // ButtonActionHandler
//                   id: "STRING_VALUE", // required
//                 },
//               },
//             },
//           },
//         ],
//       },
//     ],
//     attachments: [ // MessageAttachmentList
//       { // MessageAttachment
//         id: "STRING_VALUE", // required
//         fsId: "STRING_VALUE", // required
//         mime: "STRING_VALUE",
//         name: "STRING_VALUE", // required
//         size: Number("int"), // required
//         width: Number("int"),
//         height: Number("int"),
//         thumbnail: "STRING_VALUE",
//       },
//     ],
//     quote: { // MessageQuote
//       messageId: "STRING_VALUE", // required
//       channelId: "STRING_VALUE", // required
//       user: { // User
//         id: "STRING_VALUE", // required
//         name: "STRING_VALUE",
//         email: "STRING_VALUE",
//         phone: "STRING_VALUE",
//         picture: "STRING_VALUE",
//         locale: "STRING_VALUE",
//         timeZone: "STRING_VALUE",
//         company: "STRING_VALUE",
//         bot: true || false,
//         pbxDomain: "STRING_VALUE",
//         pbxPort: "STRING_VALUE",
//         pbxExtension: "STRING_VALUE",
//         pbxSerial: "STRING_VALUE",
//         pbxUserId: "STRING_VALUE",
//         createdAt: "STRING_VALUE",
//         updatedAt: "STRING_VALUE",
//       },
//       text: "STRING_VALUE",
//       attachments: [
//         {
//           id: "STRING_VALUE", // required
//           fsId: "STRING_VALUE", // required
//           mime: "STRING_VALUE",
//           name: "STRING_VALUE", // required
//           size: Number("int"), // required
//           width: Number("int"),
//           height: Number("int"),
//           thumbnail: "STRING_VALUE",
//         },
//       ],
//       forward: { // MessageForward
//         forwardCompany: "STRING_VALUE",
//         forwardDate: "STRING_VALUE", // required
//         forwardEmail: "STRING_VALUE",
//         forwardName: "STRING_VALUE",
//         messageId: "STRING_VALUE", // required
//         channelId: "STRING_VALUE", // required
//       },
//       mentions: [ // UsersList
//         {
//           id: "STRING_VALUE", // required
//           name: "STRING_VALUE",
//           email: "STRING_VALUE",
//           phone: "STRING_VALUE",
//           picture: "STRING_VALUE",
//           locale: "STRING_VALUE",
//           timeZone: "STRING_VALUE",
//           company: "STRING_VALUE",
//           bot: true || false,
//           pbxDomain: "STRING_VALUE",
//           pbxPort: "STRING_VALUE",
//           pbxExtension: "STRING_VALUE",
//           pbxSerial: "STRING_VALUE",
//           pbxUserId: "STRING_VALUE",
//           createdAt: "STRING_VALUE",
//           updatedAt: "STRING_VALUE",
//         },
//       ],
//       giphy: { // MessageGiphy
//         id: "STRING_VALUE", // required
//         size: "STRING_VALUE", // required
//         url: "STRING_VALUE", // required
//         height: "STRING_VALUE", // required
//         width: "STRING_VALUE", // required
//       },
//       createdAt: "STRING_VALUE", // required
//       updatedAt: "STRING_VALUE",
//     },
//     forward: {
//       forwardCompany: "STRING_VALUE",
//       forwardDate: "STRING_VALUE", // required
//       forwardEmail: "STRING_VALUE",
//       forwardName: "STRING_VALUE",
//       messageId: "STRING_VALUE", // required
//       channelId: "STRING_VALUE", // required
//     },
//     type: "regular" || "system", // required
//     giphy: {
//       id: "STRING_VALUE", // required
//       size: "STRING_VALUE", // required
//       url: "STRING_VALUE", // required
//       height: "STRING_VALUE", // required
//       width: "STRING_VALUE", // required
//     },
//     silent: true || false,
//     event: "STRING_VALUE",
//     sms: true || false,
//     smsStatus: "sent" || "delivered" || "trying" || "error",
//     whatsapp: true || false,
//     whatsappStatus: "trying" || "sent" || "delivered" || "error",
//     messageId: "STRING_VALUE", // required
//     channelId: "STRING_VALUE", // required
//     user: "<User>", // required
//     edit: true || false,
//     mentions: [
//       "<User>",
//     ],
//     latestReactions: [ // ReactionList
//       { // Reaction
//         type: "STRING_VALUE",
//         userId: "STRING_VALUE",
//         messageId: "STRING_VALUE",
//         user: "<User>",
//       },
//     ],
//     reactionCounts: { // ReactionCounts
//       "<keys>": Number("int"),
//     },
//     createdAt: "STRING_VALUE", // required
//     updatedAt: "STRING_VALUE",
//   },
// };