Mensagem de entrada com imagem, vídeo, áudio, documento#

Nesta seção, o formato de notificação de entrada do objeto messageData para mensagens de entrada com imagem, vídeo, áudio ou documento é descrito. Para obter a descrição do formato geral das notificações de entrada, consulte a seção Mensagens de entrada.

Para receber notificações de entrada desse tipo, são necessárias duas condições:

typeWebhook = incomingMessageReceived

messageData.typeMessage = imageMessage || videoMessage || documentMessage || audioMessage

Notificação#

Formato da notificação#

Campos do objeto messageData

Parâmetro	Tipo	Descrição
`typeMessage`	string	Tipo de mensagem recebida. Para mensagens deste tipo, o campo recebe o valor: `imageMessage`, `videoMessage`, `documentMessage`, `audioMessage`
`fileMessageData`	object	Objeto de dados sobre o arquivo recebido
`quotedMessage`	object	Objeto de dados sobre a mensagem citada. Está presente apenas se a própria mensagem for uma citação

Campos do objeto fileMessageData

Parâmetro	Tipo	Descrição
`downloadUrl`	string	Link para baixar o arquivo
`caption`	string	Descrição abaixo da imagem ou vídeo
`fileName`	string	Nome do arquivo
`jpegThumbnail`	string	Visualização da imagem em base64
`mimeType`	string	Tipo de arquivo, de acordo com a classificação Media Types
`isForwarded`	boolean	A mensagem é encaminhada, recebe valores true/false
`forwardingScore`	integer	Número de encaminhamentos da mensagem

Campos do objeto quotedMessage

Parâmetro	Tipo	Descrição
`stanzaId`	string	id da mensagem citada
`participant`	string	id do remetente da mensagem citada
`typeMessage`	string	Tipo de mensagem citada

Os outros campos são preenchidos dependendo do tipo da mensagem citada e são idênticos aos campos das mensagens de entrada descritas na seção Mensagens de entrada

Exemplo de corpo de notificação#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
    "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "imageMessage",
    "fileMessageData": {
      "downloadUrl": "https://api.green-api.com/waInstance1234/downloadFile/19136A974392FA8CF584D70DD0E1AEDF",
      "caption": "Imagem",
      "jpegThumbnail": "",
      "mimeType": "image/jpeg",
      "forwardingScore": 4,
      "isForwarded": true
    }
  }
}

Пример тела уведомления входящего сообщения с аудио и цитатой аудио/видео/документ#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
    "chatName": "Green API",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "audioMessage",
    "fileMessageData": {
      "downloadUrl": "https://s/990173687/801078ab-3340-4e4aa5.ogg",
      "caption": "",
      "fileName": "801078ab-3340-4f78-е9978be4aa5.ogg",
      "jpegThumbnail": "",
      "mimeType": "audio/ogg",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79001234568@c.us",
      "typeMessage": "imageMessage",
      "downloadUrl": "",
      "caption": "",
      "jpegThumbnail": ""
    }
  }
}

#

Copy code