GetChatHistory#
Метод возвращает историю сообщений чата.
Запрос#
Для получения истории сообщений требуется выполнить запрос по адресу:
{{apiUrl}}/v3/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}
Для получения параметров запроса apiUrl
, idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
chatId | string | Да | Идентификатор личного или группового чата историю сообщений которого требуется получить |
count | integer | Нет | Количество сообщений для получения. Значение по умолчанию 100 |
Пример тела запроса#
Запрос последних 10 сообщений:
{
"chatId": "12345678",
"count": 10
}
Ответ#
Ответ содержит список всех полученных и отправленных сообщений в чате. Сортировка по убыванию даты отправки сообщения.
Поля ответа#
Массив объектов с полями:
Поле | Тип | Описание |
---|---|---|
type | string | Вид сообщения: outgoing - исходящее сообщение; incoming - входящее сообщение |
idMessage | string | Идентификатор входящего сообщения |
timestamp | integer | Время принятия сообщения в UNIX-формате |
statusMessage | string | Статус исходящего сообщения. Присутствует только для type = outgoing . Возможные значения: |
pending - сообщение отправляется | ||
sent - отправлено | ||
delivered - доставлено | ||
read - прочитано/просмотрено/прослушано | ||
sendByApi | boolean | Флаг указывает отправлено сообщение из API или нет. Присутствует только для type = outgoing |
typeMessage | string | Тип сообщения, возможные значения: |
textMessage - текстовое сообщение | ||
imageMessage - сообщение с изображением | ||
videoMessage - видео сообщение | ||
documentMessage - сообщение с файлом документа | ||
audioMessage - аудио сообщение | ||
stickerMessage - сообщение со стикером | ||
reactionMessage - сообщение с реакцией | ||
locationMessage - сообщение геолокации | ||
contactMessage - сообщение с контактом | ||
extendedTextMessage - сообщение со ссылкой и превью | ||
pollMessage - сообщение с опросом | ||
pollUpdateMessage - сообщение с обновлением опросом. Присутствует только для type = incoming | ||
quotedMessage - сообщение с цитированием | ||
chatId | string | Идентификатор чата, в котором получено сообщение. |
senderId | string | Идентификатор отправителя сообщения. Присутствует только для type = incoming |
senderName | string | Имя отправителя сообщения. Присутствует только для type = incoming |
senderContactName | string | Имя отправителя из списка контактов текущего аккаунта. Присутствует только для type = incoming |
isForwarded | boolean | Флаг указывает является ли сообщение пересланным |
forwardingScore | integer | Количество пересылок сообщения |
textMessage | string | Текст сообщения, если typeMessage =textMessage /extendedTextMessage |
downloadUrl | string | Ссылка на скачивание файла, если typeMessage = imageMessage /videoMessage /documentMessage /audioMessage /stickerMessage |
caption | string | Описание файла, если typeMessage = imageMessage /videoMessage /documentMessage /audioMessage /stickerMessage |
fileName | string | Название файла, если typeMessage = imageMessage /videoMessage /documentMessage /audioMessage /stickerMessage . Поле заполняется корректно только для typeMessage = documentMessage , в остальных случаях название файла генерируется автоматически |
jpegThumbnail | string | Превью изображения в base64 кодировке, если typeMessage = imageMessage /videoMessage /documentMessage /audioMessage /stickerMessage |
mimeType | string | Тип файла, согласно класификации Media Types, если typeMessage = imageMessage /videoMessage /documentMessage /audioMessage /stickerMessage |
isAnimated | boolean | Флаг указывает анимирован ли файл, если typeMessage = imageMessage /videoMessage /documentMessage /audioMessage /stickerMessage |
location | object | Объект о структуре локации, если typeMessage = locationMessage |
contact | object | Объект о структуре контакта, если typeMessage = contactMessage |
extendedTextMessage | object | Объект с текстовым сообщением (расширенный), если typeMessage = extendedTextMessage /quotedMessage |
extendedTextMessageData | object | Объект с реакцией, если typeMessage = reactionMessage |
pollMessageData | object | Объект о структуре данных опроса, если typeMessage = pollMessage /pollUpdateMessage |
quotedMessage | object | Объект данных о цитируемом сообщении, если typeMessage = quotedMessage /reactionMessage |
deletedMessageId | string | Временно не работает. Идентификатор сообщения которое удалили. Присутствует если сообщение было удалено |
editedMessageId | string | Временно не работает. Идентификатор сообщения которое отредактировали. Присутствует если сообщение было отредактировано |
isEdited | boolean | Временно не работает. Флаг указывает редактировали ли сообщение |
isDeleted | boolean | Временно не работает. Флаг указывает удалили ли сообщение |
Поля объекта location
:
Поле | Тип | Описание |
---|---|---|
nameLocation | string | Название локации |
address | string | Адрес локации |
latitude | double | Широта локации |
longitude | double | Долгота локации |
jpegThumbnail | string | Превью изображения в base64 кодировке |
isForwarded | boolean | Флаг указывает является ли сообщение пересланным |
forwardingScore | integer | Количество пересылок сообщения |
Поля объекта contact
:
Поле | Тип | Описание |
---|---|---|
displayName | string | Отображаемое имя контакта |
vcard | string | Структура VCard (визитной карточки контакта) |
isForwarded | boolean | Флаг указывает является ли сообщение пересланным |
forwardingScore | integer | Количество пересылок сообщения |
Поля объекта extendedTextMessage
:
Поле | Тип | Описание |
---|---|---|
text | string | Текст ссылки |
description | string | Описание ссылки |
title | string | Заголовок ссылки |
previewType | string | Тип превью ссылки. Значение previewType :None устарело |
jpegThumbnail | string | Превью изображения в base64 кодировке |
stanzaId | string | ID цитируемого сообщения. Присутствует только для typeMessage = quotedMessage |
participant | string | ID чата получателя/отправителя. Присутствует только для typeMessage = quotedMessage |
isForwarded | boolean | Флаг указывает является ли сообщение пересланным |
forwardingScore | integer | Количество пересылок сообщения |
Поля объекта extendedTextMessageData
:
Поле | Тип | Описание |
---|---|---|
text | string | Реакция (эмоджи) на сообщение |
Поля объекта pollMessageData
:
Поле | Тип | Описание |
---|---|---|
stanzaId | string | id сообщения с исходящим опросом. Присутствует только для typeMessage =pollUpdateMessage |
name | string | Текст опроса |
options | array | Массив данных о вариантах выбора. Присутствует только для typeMessage =pollMessage |
votes | array | Массив данных ответов. Присутствует только для typeMessage =pollUpdateMessage |
multipleAnswers | boolean | Флаг о разрешении нескольких ответов |
Поля массива options
Параметр | Тип | Описание |
---|---|---|
optionName | string | Текст варианта выбора |
Поля массива votes
:
Параметр | Тип | Описание |
---|---|---|
optionName | string | Текст варианта выбора |
optionVoters | array | Массив идентификаторов проголосовавших аккаунтов |
Поля объекта quotedMessage
:
Поле | Тип | Описание |
---|---|---|
stanzaId | string | ID цитируемого сообщения |
participant | string | ID чата получателя |
typeMessage | string | Тип цитириуемого сообщения |
Остальные поля объекта
quotedMessage
заполняются в зависимости от типа цитируемого сообщения и идентичны полям описанных выше
Пример тела ответа#
[
{
"type": "outgoing",
"idMessage": "111111111111111111",
"timestamp": 1754999812,
"typeMessage": "extendedTextMessage",
"chatId": "12345678",
"textMessage": "Тест",
"extendedTextMessage": {
"text": "Тест",
"description": "",
"title": "",
"previewType": "None",
"jpegThumbnail": "",
"forwardingScore": 0,
"isForwarded": false
},
"statusMessage": "",
"sendByApi": true,
"deletedMessageId": "",
"editedMessageId": "",
"isEdited": false,
"isDeleted": false
},
{
"type": "outgoing",
"idMessage": "111111111111111115",
"timestamp": 1754987080,
"typeMessage": "extendedTextMessage",
"chatId": "12345678",
"textMessage": "Привет мир!",
"extendedTextMessage": {
"text": "Привет мир!",
"description": "",
"title": "",
"previewType": "None",
"jpegThumbnail": "",
"forwardingScore": 0,
"isForwarded": false
},
"statusMessage": "",
"sendByApi": true,
"deletedMessageId": "",
"editedMessageId": "",
"isEdited": false,
"isDeleted": false
},
{
"type": "incoming",
"idMessage": "111111111111111110",
"timestamp": 1754986980,
"typeMessage": "textMessage",
"chatId": "12345678",
"textMessage": "Привет",
"senderId": "12345678",
"senderName": "",
"senderContactName": "",
"deletedMessageId": "",
"editedMessageId": "",
"isEdited": false,
"isDeleted": false
}
]
Ошибки GetChatHistory#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Код HTTP | Идентификатор ошибки | Описание |
---|---|---|
400 | Bad Request Validation failed | Ошибка валидации |
400 | Bad Request Validation failed. Details: 'count' must be a number | Некорректный тип данных для поля count либо значение поля превышает максимальное безопасное целочисленное значение |
Примеры кода#
import requests
url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}"
payload = "{\r\n\t\"chatId\": \"12345678\",\r\n\t\"count\": 100\r\n}"
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"chatId": "12345678",
"count": 10
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/v3/waInstance").append({{idInstance}})
.append("/getChatHistory/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"chatId\": \"79876543210@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({{apiUrl}})
.append("/v3/waInstance").append({{idInstance}})
.append("/getChatHistory/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"chatId\": \"12345678\",\"count\": 10}")
.asString();
System.out.println(response);
Sub GetChatHistory()
Dim url As String
Dim RequestBody As String
Dim http As Object
Dim response As String
' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
url = "{{apiUrl}}/v3/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}"
' chatId - personal or group chat identifier whose message history you want to receive, count - number of messages to receive, default value 100
RequestBody = "{""chatId"":""12345678"",""count"":10}"
Set http = CreateObject("MSXML2.XMLHTTP")
With http
.Open "POST", url, False
.setRequestHeader "Content-Type", "application/json"
.send RequestBody
End With
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
Range("A1").Value = response
Set http = Nothing
End Sub