Skip to content

Sent message with a sticker#

This section describes the format of the incoming notification messageData object for a sent message with a sticker. 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 = outgoingMessageReceived || outgoingAPIMessageReceived
  • messageData.typeMessage = stickerMessage

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, Receive notifications about messages sent through the API and Receive notifications about deleted messages 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, outgoingAPIMessageWebhook and deletedMessageWebhook 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 received message. For messages of this type the field takes the value stickerMessage
stickerMessageData object Object with data about the sticker
quotedMessage object Object with data about the quoted message.
Present only if the message itself is a quote

Fields of the stickerMessageData object

Parameter Type Description
downloadUrl string Link for downloading the sticker
fileName string File name. For standard stickers it takes the value "AnimatedSticker.tgs"
jpegThumbnail string Sticker preview in base64
mimeType string File type:
- "application/x-tgsticker" for standard stickers,
- "image/webp" for custom ones
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 from a personal chat#

{
  "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": "stickerMessage",
    "stickerMessageData": {
      "downloadUrl": "https://4100.api.green-api.com/download/4100/1763115112345.webp",
      "fileName": "AnimatedSticker.tgs",
      "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
      "isAnimated": true,
      "mimeType": "application/x-tgsticker",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

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

{
  "typeWebhook": "outgoingMessageReceived",
  "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": 79876543210
  },
  "messageData": {
    "typeMessage": "stickerMessage",
    "stickerMessageData": {
      "downloadUrl": "https://4100.api.green-api.com/download/4100/1763115112345.webp",
      "fileName": "1763115112.webp",
      "jpegThumbnail": "UklGRjoAAABXRUJQVlA4IC4AAACwAwCdASoyADIAPm0skkYkIqGhLggAgA2JaQAAZAEm0xUUDzF5wAD++yGAAAAA",
      "isAnimated": false,
      "mimeType": "image/webp",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}