GetChatHistory#

Este método retorna o histórico de mensagens de um chat.

Solicitação#

Para obter o histórico de mensagens, é necessário enviar uma requisição para o seguinte endereço:

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

Para obter os parâmetros idInstance e apiTokenInstance, consulte a seção [Antes de começar].(../../before-start.md#parameters).

Parâmetros da Solicitação#

Параметр	Тип	Обязательный	Описание
`chatId`	string	Sim	Identificador do chat pessoal ou em grupo para o qual deseja obter o histórico de mensagens.
`count`	integer	Não	Quantidade de mensagens a serem obtidas. O valor padrão é `100`.

Exemplo de corpo da solicitação#

Solicitação das últimas 10 mensagens:

{
    "chatId": "11001234567@c.us",
    "count": 10
}

Resposta#

A resposta contém uma lista de todas as mensagens recebidas e enviadas no chat. Ordenadas por data de envio em ordem decrescente.

Campos da Resposta#

Matriz de objetos com os seguintes campos:

Campos da Resposta#

Matriz de objetos com os seguintes campos:

Campo	Tipo	Descrição
`type`	string	Tipo da mensagem: `outgoing` - mensagem enviada; `incoming` - mensagem recebida
`timestamp`	integer	Tempo de envio da mensagem em formato UNIX
`idMessage`	string	Identificador da mensagem
`statusMessage`	string	Status da mensagem de saída. Presente somente se o `type` for `outgoing`. Valores possíveis: `pending` - mensagem sendo enviada; `sent` - enviada; `delivered` - entregue; `read` - lida/visualizada/ouvida
`typeMessage`	string	Tipo da 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 de contato; `extendedTextMessage` - mensagem com link e prévia
`chatId`	string	Identificador do chat
`senderId`	string	Identificador do remetente da mensagem recebida. Presente somente se o `type` for `incoming`
`senderName`	string	Nome do remetente da mensagem recebida. Presente somente se o `type` for `incoming`
`textMessage`	string	Texto da mensagem, caso o `typeMessage` seja `textMessage`
`downloadUrl`	string	Link para download do arquivo, caso o `typeMessage` seja `imageMessage`/`videoMessage`/`documentMessage`/`audioMessage`
`caption`	string	Descrição do arquivo, caso o `typeMessage` seja `imageMessage`/`videoMessage`/`documentMessage`
`location`	object	Objeto contendo informações sobre a localização, caso o `typeMessage` seja `locationMessage`
`contact`	object	Objeto contendo informações sobre o contato, caso o `typeMessage` seja `contactMessage`
`extendedTextMessage`	object	Objeto contendo informações sobre o link e prévia, caso o `typeMessage` seja `extendedTextMessage`

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 em formato `base64` da imagem

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 em formato `base64` da imagem

Exemplo do corpo da resposta#

[
    {
        "type": "incoming",
        "timestamp": 1603964449,
        "idMessage": "3AADDD555CB0822C0539",
        "typeMessage": "textMessage",
        "chatId": "11001234567@c.us",
        "senderId": "11001234567@c.us",
        "senderName": "Andrew Sh",
        "textMessage": "Eu uso Green-API para receber esta mensagem de você!"
    },
    {
        "type": "outgoing",
        "timestamp": 1603964445,
        "idMessage": "3EB08816FEBCCC3FACD2",
        "statusMessage": "read",
        "typeMessage": "textMessage",
        "chatId": "11001234567@c.us",
        "textMessage": "Eu uso Green-API para enviar esta mensagem para você!"
    },
    {
        "type": "incoming",
        "timestamp": 1603964444,
        "idMessage": "3AA45F9F285C5249CDFC",
        "typeMessage": "imageMessage",
        "chatId": "11001234567@c.us",
        "senderId": "11001234567@c.us",
        "senderName": "Andrew Sh",
        "downloadUrl": "https://api.green-api.com/waInstance9075/downloadFile/download-file-id",
        "caption": "Logo da Green-API"
    }
]

Erros do GetChatHistory#

Consulte a lista de erros comuns a todos os métodos na seção Erros Comuns

Exemplo de código em Python#

import requests

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

payload = "{\r\n\t\"chatId\": \"11001234567@c.us\",\r\n\t\"count\": 100\r\n}"
headers = {
  'Content-Type': 'application/json'
}

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

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