getChatHistory

Отдаёт последние сообщения чата: входящие, свои и звонки. Нужен, когда оператор открывает чат в вашей системе, и после уведомления syncGap — чтобы забрать то, что могло не прийти уведомлениями.

Параметры

Пример запроса

Два последних сообщения переписки с Марией в MAX:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getChatHistory/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "8695836", "count": 2}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/getChatHistory/{TOKEN}"
payload = {"chatId": "8695836", "count": 2}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/getChatHistory/${GRATIO_TOKEN}`;
const payload = { chatId: "8695836", count: 2 };
const response = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getChatHistory/' . getenv('GRATIO_TOKEN');
$payload = ['chatId' => '8695836', 'count' => 2];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK — массив сообщений. Мария спросила про места, канал ответил цитатой через API, Мария прочитала:

[
  {
    "type": "outgoing",
    "idMessage": "117428956522361912",
    "timestamp": 1791823671,
    "chatId": "8695836",
    "chatType": "user",
    "senderId": "457747484",
    "senderName": "",
    "senderContactName": "",
    "isForwarded": false,
    "forwardingScore": 0,
    "typeMessage": "quotedMessage",
    "textMessage": "Да, место есть. Записали вас на субботу, 11:00.",
    "extendedTextMessageData": {
      "text": "Да, место есть. Записали вас на субботу, 11:00.",
      "stanzaId": "117428955282341903",
      "participant": "8695836"
    },
    "quotedMessage": {
      "stanzaId": "117428955282341903",
      "participant": "8695836",
      "typeMessage": "textMessage",
      "textMessage": "Здравствуйте! Есть места на субботу?"
    },
    "statusMessage": "read",
    "sendByApi": true
  },
  {
    "type": "incoming",
    "idMessage": "117428955282341903",
    "timestamp": 1791823658,
    "chatId": "8695836",
    "chatType": "user",
    "senderId": "8695836",
    "senderName": "Мария",
    "senderContactName": "",
    "isForwarded": false,
    "forwardingScore": 0,
    "typeMessage": "textMessage",
    "textMessage": "Здравствуйте! Есть места на субботу?"
  }
]

Поля ответа

Остальные поля — файлы, цитата, звонок, письмо — в статье Элемент журнала.

Ещё примеры

WhatsApp

chatId — адрес чата WhatsApp, он же номер собеседника:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getChatHistory/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "79991234567@c.us", "count": 50}'

Почта

chatId — адрес собеседника. В ответе — его письма и ваши ответы ему:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getChatHistory/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "maria@client.ru", "count": 20}'

Особенности каналов

Если порядок важен, сортируйте по timestamp у себя.

• Статусы и пометки. Если сообщение прошло через Gratio, statusMessage, sendByApi, isDeleted и isEdited берутся из журнала Gratio и актуальны. У сообщений до подключения статус — тот, что сообщила площадка, или sent.
• MAX. Повтор с теми же chatId и count в течение 5 секунд отвечает из кэша, MAX не спрашивают.
• Публичные каналы и группы MAX и Telegram можно читать без вступления — после getChatPreview.
• Не опрашивайте историю по всем чатам подряд: для новых сообщений есть уведомления. Подробно — Темп и лимиты.

Ошибки

Общие правила — в статье Ответы и ошибки.

Что дальше

• Элемент журнала — все поля сообщения в ответе.
• getMessage — одно сообщение по id.
• lastIncomingMessages и lastOutgoingMessages — сообщения всех чатов за период.
• syncGap — когда историю нужно перечитать после простоя.