GetChatHistory#

The method returns the chat message history.

To obtain the full chat message history:

1. Receive messages sent from the phone by enabling the Receive webhooks on messages sent from phone setting using the SetSettings method or through the personal account. Messages sent via the API are automatically recorded in the log.

2. Receive incoming messages by enabling the Receive webhooks on incoming messages and files setting using the SetSettings method or through the personal account.

Messages sent and received before enabling these settings will not be included in the log.

It may take up to 5 minutes for the settings to take effect.

The appearance of messages in the log may take up to 2 minutes. Log methods should only be used for retrieving chat history. For quicker message retrieval, use the notification system.

To receive incoming messages from the phone's history, you need to enable the instance setting Receive webhooks on incoming messages and files using the SetSettings method or through the personal account and scan the QR code; the history will then appear in the logs.

The GetChatHistory method only returns the history that WhatsApp provides to the system.

Request#

To get chat history, you have to execute a request at:

POST https://api.greenapi.com/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}

For idInstance and apiTokenInstance request parameters, please refer to Before you start section.

Request parameters#

Request body example#

10 last messages request:

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

Response#

The response contains a list of all received and sent messages in the chat. Message time stamp descending-order sort.

Response parameters#

Array of objects with parameters:

Parameters of location object:

Parameters of contact object:

Parameters of extendedTextMessage object:

Response body example#

[
    {
        "type": "incoming",
        "timestamp": 1603964449,
        "idMessage": "3AADDD555CB0822C0539",
        "typeMessage": "textMessage",
        "chatId": "11001234567@c.us",
        "senderId": "11001234567@c.us",
        "senderName": "Andrew Sh",
        "textMessage": "I use Green-API to get this message from you!"
    },
    {
        "type": "outgoing",
        "timestamp": 1603964445,
        "idMessage": "3EB08816FEBCCC3FACD2",
        "statusMessage": "read",
        "typeMessage": "textMessage",
        "chatId": "11001234567@c.us",
        "textMessage": "I use Green-API to send this message to you!"
    },
    {
        "type": "incoming",
        "timestamp": 1603964444,
        "idMessage": "3AA45F9F285C5249CDFC",
        "typeMessage": "imageMessage",
        "chatId": "11001234567@c.us",
        "senderId": "11001234567@c.us",
        "senderName": "Andrew Sh",
        "downloadUrl": "https://api.greenapi.com/waInstance9075/downloadFile/download-file-id",
        "caption": "Green-API Logo"
    }
]

GetChatHistory errors#

For a list of errors common to all methods, refer to Common errors section

Request examples#

import requests

url = "https://api.greenapi.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'))

curl --location 'https://api.green-api.com/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "count": 10
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/getChatHistory/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\"chatId\": \"11001234567@c.us\",\"count\": 10}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/getChatHistory/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\"chatId\": \"11001234567@c.us\",\"count\": 10}")
    .asString();

System.out.println(response);