Отмечает входящие сообщения прочитанными: до указанного сообщения или все в чате. Собеседник увидит «прочитано». Вызывайте, когда сообщение действительно обработано — оператором или ботом.
| Запрос | POST /waInstance{idInstance}/readChat/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp, почта |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | чат — адрес из уведомления или истории. Поиска по номеру здесь нет |
idMessage |
string | нет | прочитано до этого сообщения. Без него — весь чат |
Пример запроса
Отметить прочитанным сообщение Марии в MAX:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/readChat/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"chatId": "8695836", "idMessage": "117428955282341903"}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/readChat/{TOKEN}"
payload = {"chatId": "8695836", "idMessage": "117428955282341903"}
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}/readChat/${GRATIO_TOKEN}`;
const payload = { chatId: "8695836", idMessage: "117428955282341903" };
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 . '/readChat/' . getenv('GRATIO_TOKEN');
$payload = ['chatId' => '8695836', 'idMessage' => '117428955282341903'];
$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:
{"setRead": true}
Ещё примеры
Весь чат
Без idMessage — до последнего сообщения:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/readChat/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"chatId": "8695836"}'
Письмо
У почты — пометить письмо прочитанным в ящике:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/readChat/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "maria@client.ru",
"idMessage": "c62b698304229a98aad3"
}'
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId; адрес чата или id не этого канала |
исправить запрос |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
400 |
код площадки | чат не найден | см. message |
Особенности каналов
- MAX. Отвечая через sendMessage и sendFileByUpload, вызывать
readChatне нужно: Gratio отмечает входящие прочитанными сам перед отправкой. - Telegram и WhatsApp. «Прочитано» видно и на телефоне сотрудника: чат там тоже станет прочитанным.
- Почта. С
idMessage— это письмо, без него — все непрочитанные письма собеседника во «Входящих» помечаются прочитанными в ящике.
Что дальше
- outgoingMessageStatus — узнать, что собеседник прочитал ваше сообщение.
- sendTyping — показать «печатает», пока готовите ответ.
- Переписка в своей CRM — когда ставить «прочитано» в интерфейсе оператора.
