Ir para o conteúdo

Mensagem de texto recebida, mensagem com URL ou mensagem de publicidade#

Esta seção descreve o formato da notificação recebida do objeto messageData para uma mensagem de texto recebida ou uma mensagem com uma URL. Para uma descrição do formato geral das notificações recebidas, consulte a seção Mensagens recebidas.

Para receber notificações recebidas deste tipo, duas condições devem ser atendidas:

typeWebhook = incomingMessageReceived

messageData.typeMessage = extendedTextMessage

Notificação#

Formato de 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 extendedTextMessage
extendedTextMessageData object Objeto de dados sobre a mensagem de texto recebida ou o link URL
quotedMessage object Objeto de dados sobre a mensagem citada. Está presente apenas se a própria mensagem é uma citação

Campos do objeto extendedTextMessageData

Parâmetro Tipo Descrição
text string Link de texto ou texto comum
description string Descrição do link, pode estar vazio
title string Título do link, pode estar vazio
jpegThumbnail string Pré-visualização de imagem em codificação base64, pode estar ausente
isForwarded boolean Se a mensagem é encaminhada, recebe valores verdadeiro/falso
forwardingScore integer Quantidade de encaminhamentos da mensagem
previewType string Tipo de pré-visualização. (apenas para mensagens publicitárias)
containsAutoReply boolean Se a mensagem contém uma resposta automática. (apenas para mensagens publicitárias)
mediaType string Tipo de mensagem de mídia, por exemplo "IMAGE". (apenas para mensagens publicitárias)
showAdAttribution boolean Mostrar atributos de publicidade na mensagem. (apenas para mensagens publicitárias)
sourceId string Id da publicidade. (apenas para mensagens publicitárias)
sourceType string Tipo de fonte, por exemplo "ad". (apenas para mensagens publicitárias)
sourceUrl string Link para a publicidade. (apenas para mensagens publicitárias)
thumbnailUrl string Link para a pré-visualização da imagem. (apenas para mensagens publicitárias)

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 da mensagem citada

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

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": "extendedTextMessage",
        "extendedTextMessageData": {
            "text": "https://green-api.com.br/docs/video",
            "description": "Os documentos da Green API mostram como você pode desenvolver o Bot WhatsApp",
            "title": "Como desenvolver Bot WhatsApp",
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYG==",
            "forwardingScore": 4,
            "isForwarded": true
        }
    }
}
````

### Exemplo de corpo de notificação de mensagem recebida com link ou texto e citação de contato {#webhook-example-body}

```json
{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "quotedMessage",
    "extendedTextMessageData": {
      "text": "https://yandex.ru/former&utm_source=home&utm_content=main_informer&utm_term=main_number",
      "stanzaId": "0EA554E587820E35309858AE265BE7EA",
      "participant": "79001230000@c.us",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79061230000@c.us",
      "typeMessage": "contactMessage",
      "contact": {
        "displayName": "Green-Api",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Green-Api\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Móvel\nEND:VCARD"
      }
    }
  }
}

Exemplo de corpo de notificação de mensagem recebida com link e citação de imagem#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
    "senderName": "Green API"
  },
  "messageData": {
    "typeMessage": "quotedMessage",
    "extendedTextMessageData": {
      "text": "https://yandex.ru/pogoda/?utm_medium=source=home&utm_content=main_informer&utm_term=main_number",
      "stanzaId": "B4AA239D112CB2576897B3910FEDE26E",
      "participant": "79001230000@c.us",
        "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79061230000@c.us",
      "typeMessage": "imageMessage",
      "downloadUrl": "",
      "caption": "",
      "jpegThumbnail": ""
    }
  }
}