Skip to content

Incoming message with a document#

This section describes the format of the incoming notification messageData object for an incoming message with a document. 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 = documentMessage

Instance settings

To receive incoming notifications about messages with an image, video, audio or document, 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: documentMessage
fileMessageData object Object with data about the received file
quotedMessage object Object with data about the quoted message.
Present only if the message itself is a quote

Fields of the fileMessageData object

Parameter Type Description
downloadUrl string Link for downloading the file
caption string Caption under the image or video
fileName string File name.
jpegThumbnail string Image preview in base64
mimeType string File type, according to the Media Types classification
forwardingScore integer Number of times the message has been forwarded
isForwarded boolean Flag of a forwarded message, true/false

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 with a document 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": "documentMessage",
    "fileMessageData": {
      "downloadUrl": "https://4100.api.green-api.com/download/4100/d34044f0-c76e-4be3-b412-1befcce9d538.pdf",
      "caption": "",
      "fileName": "1763115112.pdf",
      "jpegThumbnail": "",
      "mimeType": "application/pdf",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

Example of a notification body for a message with a document 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": "documentMessage",
    "fileMessageData": {
      "downloadUrl": "https://4100.api.green-api.com/download/4100/d34044f0-c76e-4be3-b412-1befcce9d538.pdf",
      "caption": "",
      "fileName": "1763115112.pdf",
      "jpegThumbnail": "",
      "mimeType": "application/pdf",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}