Mensagem recebida com geolocalização#
Esta seção descreve o formato da notificação de entrada do objeto messageData
para uma mensagem recebida com geolocalização. Para obter a descrição do formato geral das notificações recebidas, consulte a seção Mensagens recebidas.
Duas condições devem ser atendidas para receber notificações desse tipo:
typeWebhook
= incomingMessageReceived
messageData.typeMessage
= locationMessage
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 locationMessage |
locationMessageData | object | Objeto de dados sobre a geolocalização recebida |
quotedMessage | object | Objeto de dados sobre a mensagem citada. Presente apenas se a própria mensagem for uma citação |
Campos do objeto locationMessageData
Parâmetro | Tipo | Descrição |
---|---|---|
latitude | double | Latitude da localização |
longitude | double | Longitude da localização |
jpegThumbnail | string | Pré-visualização da imagem em codificação base64 |
isForwarded | boolean | Se a mensagem é encaminhada, recebe os valores true/false |
forwardingScore | integer | Quantidade 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 da mensagem citada |
Os demais campos são preenchidos dependendo do tipo de 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": "locationMessage",
"locationMessageData": {
"latitude": 12.345678910111213,
"longitude": 14.151617181920212,
"jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFx=",
"forwardingScore": 4,
"isForwarded": true
}
}
}
Exemplo de corpo de notificação de mensagem recebida com geolocalização e citação de uma mensagem de texto#
{
"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": "locationMessage",
"locationMessageData": {
"nameLocation": "",
"address": "",
"jpegThumbnail": "217",
"latitude": 74.5922641,
"longitude": 59.6645355,
"forwardingScore": 4,
"isForwarded": true
},
"quotedMessage": {
"stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
"participant": "79001230022@c.us",
"typeMessage": "textMessage",
"textMessage": "Olá"
}
}
}