Skip to content

Incoming edited message#

This section describes the format of the incoming notification messageData object for an incoming edited message. For a description of the general format of incoming notifications, refer to the Incoming messages section.

To receive incoming notifications of this kind, three conditions must be met:

  • typeWebhook = incomingMessageReceived
  • editedMessageWebhook = yes
  • messageData.typeMessage = editedMessage

Instance settings

To receive incoming notifications about incoming messages, you need to enable the settings in one of the ways presented:

  1. Through the console, enable the Receive notifications about incoming messages and files and Receive notifications about edited messages settings.

  2. Through the SetSettings method, enable the incomingWebhook and editedMessageWebhook settings.

Notification#

Notification format#

Fields of the messageData object

Parameter Type Description
typeMessage string Type of the received message. For messages of this type the field takes the value editedMessage
editedMessageData object Object with data about the edited message

Fields of the editedMessageData object

Parameter Type Description
textMessage string Text of the edited message
stanzaId string ID of the message that was edited

Notification body example#

Example of a notification body for an edited message from a personal chat#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1705895506,
  "idMessage": "115297976845823798",
  "senderData": {
    "chatId": "10000000",
    "chatType": "user",
    "sender": "10000000",
    "chatName": "Vasilisa the Wise",
    "senderName": "Vasilisa the Wise",
    "senderType": "user",
    "senderContactName": "Vasilisa the Wise",
    "senderPhoneNumber": 79998887766
  },
  "messageData": {
    "typeMessage": "editedMessage",
    "editedMessageData": {
      "textMessage": "Edited message",
      "stanzaId": "11529797684582123"
    }
  }
}

Example of a notification body for an edited message from a group chat#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "-10000000000000",
    "chatType": "channel",
    "sender": "10000000",
    "chatName": "Faraway Kingdom",
    "senderName": "Vasilisa",
    "senderType": "user",
    "senderContactName": "",
    "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "editedMessage",
    "editedMessageData": {
      "textMessage": "Edited message",
      "stanzaId": "11529797684582123"
    }
  }
}