Ir para o conteúdo

Mensagens recebidas#

Nesta seção, é fornecida uma descrição do formato geral das notificações recebidas com o tipo incomingMessageReceived. A descrição de todos os tipos de notificações recebidas é apresentada na seção Tipos de notificações recebidas.

O sistema prevê o recebimento de notificações sobre as seguintes tipos de mensagens recebidas:

Campos de notificação recebidaMessageReceived#

Parâmetro	Tipo	Descrição
`typewebhook`	string	Tipo de notificação recebida. Para uma notificação deste tipo, o campo assume o valor `incomingMessageReceived`
`instanceData`	objeto	Informação da conta
`carimbo de data/hora`	inteiro	Hora do evento no formato UNIX
`idMessage`	string	ID da mensagem recebida
`dados do remetente`	objeto	Informações sobre o remetente da mensagem ou arquivo
`messageData`	objeto	Informações sobre a mensagem ou arquivo recebido

Campos do objeto instanceData

Parâmetro	Tipo	Descrição
`idInstance`	integer	Identificador de conta
`wid`	string	Identificador de conta no formato WhatsApp
`typeInstance`	string	Tipo de mensageiro para a conta

Campos do objeto senderData

Parâmetro	Tipo	Descrição
`chatId`	string	ID do chat em que a mensagem ou arquivo foi recebido
`remetente`	string	Identificador do remetente da mensagem ou arquivo
`chatName`	string	Nome no chat
`remetente`	string	Nome do remetente

Campos do objeto `messageData`#

O objeto messageData possui diferentes campos dependendo do tipo de mensagem 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":{
       // Dependendo do typeMessage = textMessage || imageMessage || videoMessage || documentMessage || audioMessage || locationMessage || contactMessage || extendedTextMessage || quotedMessage
       ...
       ...
       ...
        }
    }
}