GetMessage#

Método para obter uma mensagem de chat.

Requisição#

Para obter uma mensagem, faça uma solicitação para o seguinte endereço:

POST https://api.green-api.com/waInstance{{idInstance}}/getMessage/{{apiTokenInstance}}

Para obter os parâmetros da requisição idInstance e apiTokenInstance, consulte a seção Antes de começar.

Parâmetros da Requisição#

Parâmetro	Tipo	Obrigatório	Descrição
`chatId`	string	Sim	Identificador de chat pessoal ou de grupo da mensagem a ser obtida
`idMessage`	string	Sim	ID da mensagem

Exemplo de Corpo da Requisição#

Solicitação de mensagem:

{
  "chatId": "120363043968066561@g.us",
  "idMessage": "BAE5F4886F6F2D05"
}

Resposta#

A resposta contém a mensagem recebida ou enviada no chat.

Campos da resposta#

Objeto com os seguintes campos:

Campo	Tipo	Descrição
`idMessage`	string	Identificador da mensagem recebida
`timestamp`	integer	Horário de recebimento da mensagem no formato UNIX
`typeMessage`	string	Tipo de mensagem, valores possíveis: `textMessage` - mensagem de texto `imageMessage` - mensagem com imagem `videoMessage` - mensagem de vídeo `documentMessage` - mensagem com arquivo de documento `audioMessage` - mensagem de áudio `locationMessage` - mensagem de localização `contactMessage` - mensagem com contato `extendedTextMessage` - mensagem com link e visualização `quotedMessage` - mensagem citada (DESCONTINUADO) `buttonsMessage` - mensagem com botões `templateMessage` - mensagem com botões de modelo `listMessage` - mensagem com botão de lista `buttonsResponseMessage` - resposta com botões `templateButtonsReplyMessage` - resposta com botões personalizados `listResponseMessage` - resposta com lista
`chatId`	string	Identificador do chat onde a mensagem foi recebida
`senderId`	string	Identificador do remetente da mensagem
`senderName`	string	Nome do remetente da mensagem
`textMessage`	string	Texto da mensagem, se `typeMessage`=`textMessage`
`downloadUrl`	string	URL para download do arquivo, se `typeMessage` = `imageMessage`/`videoMessage`/`documentMessage`/`audioMessage`
`caption`	string	Descrição do arquivo
`location`	object	Objeto com informações sobre a localização
`contact`	object	Objeto com informações sobre o contato
`extendedTextMessage`	object	Objeto com mensagem de texto estendida (DEPRECIADO)
`quotedMessage`	object	Objeto com dados da mensagem citada. Presente somente se a própria mensagem for uma citação

Campos do objeto location:

Campo	Tipo	Descrição
`nameLocation`	string	Nome da localização
`address`	string	Endereço da localização
`latitude`	double	Latitude da localização
`longitude`	double	Longitude da localização
`jpegThumbnail`	string	Miniatura da imagem em formato `base64`

Campos do objeto contact:

Campo	Tipo	Descrição
`displayName`	string	Nome exibido do contato
`vcard`	string	Estrutura VCard (cartão de visita) do contato

Campos do objeto extendedTextMessage:

Campo	Tipo	Descrição
`text`	string	Texto do link
`description`	string	Descrição do link
`title`	string	Título do link
`previewType`	string	Tipo de visualização do link
`jpegThumbnail`	string	Miniatura da imagem em formato `base64`
`stanzaId`	string	ID da mensagem citada
`participant`	string	ID do chat do destinatário

Exemplo de corpo de resposta#

    {
        "idMessage": "DE8CFFA93B95237B077F8FA08331A0B5",
        "timestamp": 1587129319,
        "typeMessage": "textMessage",
        "chatId": "11001234567@c.us",
        "senderId": "11001234567@c.us",
        "senderName": "João Silva",
        "textMessage": "Olá"
    }

    {
        "idMessage": "EA0BD1AE042DC4F3609867126309D67C",
        "timestamp": 1587147598,
        "typeMessage": "imageMessage",
        "chatId": "11001234567@c.us",
        "senderId": "11001234567@c.us",
        "senderName": "João Silva",
        "downloadUrl": "https://api.green-api.com/waInstance1234/downloadFile/EA1BD1AE042DC4F3609867126309D67C",
        "caption": "Como você está?"
    }

    {
        "idMessage": "DE8CFFA93B95237B077F8FA08331A0B5",
        "timestamp": 1587129319,
        "typeMessage": "locationMessage",
        "chatId": "71234567891@c.us",
        "senderId": "1234567891@c.us",
        "senderName": "Maria Souza",
        "location": {
            "nameLocation": "Estou aqui, venha aqui",
            "address": "614111, Perm",
            "latitude": 53.9370129,
            "longitude": 54.8728409,
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wB=="
        }
    }

    {
        "idMessage": "DE8CFFA93B95237B077F8FA08331A0B5",
        "timestamp": 1587129319,
        "typeMessage": "contactMessage",
        "chatId": "1234567891@c.us",
        "senderId": "71234567891@c.us",
        "senderName": "Maria Souza",
        "contact": {
            "displayName": "Pedro Santos",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andreevich;Pedro;;;\nFN:Pedro Andreevich\nORG:Image\nTITLE:\nitem1.TEL;waid=79099291652:+7 123 456-78-91\nitem1.X-ABLabel:Мobilen\nEND:VCARD"
        }
    }

    {
        "idMessage": "DE8CFFA93B95237B077F8FA08331A0B5", 
        "timestamp": 1587129319,
        "typeMessage": "extendedTextMessage",
        "chatId": "1234567891@c.us",
        "senderId": "71234567891@c.us",
        "senderName": "Maria Souza",
        "extendedTextMessage": {
            "text": "https://www.youtube.com/watch?v=9lO06Zxhu8*8*",
            "description": "Vídeo",
            "title": "Vídeo incrível",
            "previewType": "video",
            "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wB=="
        }
    }

    {
        "idMessage": "6195B3523153621DFDFC184D3317E80D",
        "timestamp": 1603182280,
        "typeMessage": "quotedMessage",
        "chatId": "71234567891@c.us",
        "senderId": "71234567891@c.us",
        "senderName": "Meu",
        "textMessage": "Citação de teste",
        "extendedTextMessage": {
            "stanzaId": "3A6424373F90A939B3C8",
            "participant": "71987654321@c.us"
        }
    }

Erros de GetMessage#

Lista de erros comuns a todos os métodos. Consulte a seção Erros Comuns para obter mais detalhes.

Código HTTP	Identificador do erro	Descrição
400	`chatId not found`	chatID não encontrado
400	`ID message notfound`	ID da mensagem não encontrado

Exemplo de código em Python#

import requests

url = "https://api.green-api.com/waInstance{{idInstance}}/getMessage/{{apiTokenInstance}}"

payload = "{\r\n\"chatId\": \"120363043968066561@g.us\, \"idMessage\": \"BAE5F4886F6F2D05\" \"r\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))