Skip to main content

@wildix/xbees-conversations-client > PartialUpdateMessageCommand

PartialUpdateMessageCommand class​

Partially updates an existing message in a specified channel. This operation requires the channel and message to be accessible to the user.

Signature:

export declare class PartialUpdateMessageCommand extends PartialUpdateMessageCommand_base

Extends: PartialUpdateMessageCommand_base

Example​

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

import { ConversationsClient, PartialUpdateMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, PartialUpdateMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // PartialUpdateMessageInput
  channelId: "STRING_VALUE", // required
  messageId: "STRING_VALUE", // required
  userId: "STRING_VALUE",
  set: { // PartialUpdateMessageSetInput
    text: "STRING_VALUE",
    elements: [ // ElementsList
      { // Element Union: only one key present
        template: { // MessageTemplateConfig
          whatsapp: { // TemplateWithParameters
            name: "STRING_VALUE", // required
            parameters: [ // ListTemplateParameter // required
              { // TemplateParameter
                name: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
            ],
          },
        },
        actions: [ // ActionsElementsList
          { // ActionElement Union: only one key present
            button: { // ButtonElement
              text: "STRING_VALUE", // required
              handler: { // ButtonHandler Union: only one key present
                link: { // ButtonLinkHandler
                  url: "STRING_VALUE", // required
                },
                reply: { // ButtonReplyHandler
                  text: "STRING_VALUE",
                },
                action: { // ButtonActionHandler
                  id: "STRING_VALUE", // required
                },
              },
              variant: "contained" || "outlined",
              disabled: true || false,
            },
          },
        ],
      },
    ],
    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
    },
    whatsapp: true || false,
    whatsappStatus: "trying" || "sent" || "delivered" || "error",
    sms: true || false,
    smsStatus: "sent" || "delivered" || "trying" || "error",
    mentions: [ // UsersIdList
      "STRING_VALUE",
    ],
  },
  unset: [ // MessageUnsetFieldsList
    "text" || "mentions" || "elements" || "attachments" || "quote" || "forward" || "whatsapp" || "whatsappStatus" || "sms" || "smsStatus",
  ],
  silent: true || false,
};
const command = new PartialUpdateMessageCommand(input);
const response = await client.send(command);
// { // PartialUpdateMessageOutput
//   message: { // Message
//     text: "STRING_VALUE",
//     elements: [ // ElementsList
//       { // Element Union: only one key present
//         template: { // MessageTemplateConfig
//           whatsapp: { // TemplateWithParameters
//             name: "STRING_VALUE", // required
//             parameters: [ // ListTemplateParameter // required
//               { // TemplateParameter
//                 name: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//             ],
//           },
//         },
//         actions: [ // ActionsElementsList
//           { // ActionElement Union: only one key present
//             button: { // ButtonElement
//               text: "STRING_VALUE", // required
//               handler: { // ButtonHandler Union: only one key present
//                 link: { // ButtonLinkHandler
//                   url: "STRING_VALUE", // required
//                 },
//                 reply: { // ButtonReplyHandler
//                   text: "STRING_VALUE",
//                 },
//                 action: { // ButtonActionHandler
//                   id: "STRING_VALUE", // required
//                 },
//               },
//               variant: "contained" || "outlined",
//               disabled: true || false,
//             },
//           },
//         ],
//       },
//     ],
//     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
//     },
//     whatsapp: true || false,
//     whatsappStatus: "trying" || "sent" || "delivered" || "error",
//     sms: true || false,
//     smsStatus: "sent" || "delivered" || "trying" || "error",
//     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",
//     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",
//   },
// };