Skip to content

Sent text message#

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

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

  • typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived
  • messageData.typeMessage = textMessage

Instance settings

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

  1. Through the console, enable the Receive notifications about messages sent from the phone and Receive notifications about messages sent through the API settings (additionally Receive notifications about the statuses of sent messages to receive notifications about the statuses of a sent message)

  2. Through the SetSettings method, enable the outgoingMessageWebhook and outgoingAPIMessageWebhook settings (additionally outgoingWebhook to receive notifications about the statuses of a sent message)

Notification#

Notification format#

Fields of the messageData object

Parameter Type Description
typeMessage string Type of the sent 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

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 sent text message#

{
  "typeWebhook": "outgoingMessageReceived",
  "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": 79876543210
  },
  "messageData": {
    "typeMessage": "textMessage",
    "textMessageData": {
      "textMessage": "I use GREEN-API to send this message!"
    }
  }
}

Example of a notification body for a text message sent to a group chat#

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