Skip to content

Incoming text message#

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

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

  • typeWebhook = incomingMessageReceived
  • messageData.typeMessage = textMessage

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 setting

  2. Through the SetSettings method, enable the incomingWebhook setting

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 textMessage
textMessageData object Object with data about the text message
quotedMessage object Object with data about the quoted message.
Present only if the message itself is a quote

Fields of the textMessageData object

Parameter Type Description
textMessage string Text message
isForwarded boolean Whether the message is forwarded, takes the values true/false
forwardingScore integer Number of times the message has been forwarded

Fields of the quotedMessage object

Parameter Type Description
stanzaId string id of the quoted message
participant string id of the sender of the quoted message

Notification body example#

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "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": "textMessage",
    "textMessageData": {
      "textMessage": "I use GREEN-API to send this message!",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "telegram"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "-10000000000000",
    "chatType": "supergroup",
    "sender": "10000000",
    "chatName": "Faraway Kingdom",
    "senderName": "Vasilisa",
    "senderType": "user",
    "senderContactName": "",
    "senderPhoneNumber": 0
  },
  "messageData": {
    "typeMessage": "textMessage",
    "textMessageData": {
      "textMessage": "I use GREEN-API to send this message!",
      "forwardingScore": 1,
      "isForwarded": true
    }
  }
}