Возвращает все письма цепочки, к которой относится письмо, от первого к последнему: входящие и ваши ответы вместе. Цепочка — письма, связанные заголовками References и In-Reply-To, в том числе с разными адресатами.
| Запрос | POST /waInstance{idInstance}/getThread/{apiTokenInstance} |
| Тело | JSON |
| Каналы | почта |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
folder + uid |
string, integer | одно из трёх | любое письмо цепочки: папка и номер письма в ней |
idMessage |
string | одно из трёх | id любого письма цепочки |
messageId |
string | одно из трёх | Message-ID любого письма цепочки |
chatId |
string | нет | адрес собеседника — вместе с idMessage |
limit |
integer | нет | сколько последних писем цепочки вернуть, 1–500. По умолчанию 100 |
Письмо указывают так же, как в других методах, — см. Почта через API.
Пример запроса
Цепочка по последнему письму Марии:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getThread/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"idMessage": "7877cd439c05bc16617b",
"chatId": "maria@client.ru"
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/getThread/{TOKEN}"
payload = {"idMessage": "7877cd439c05bc16617b", "chatId": "maria@client.ru"}
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}/getThread/${GRATIO_TOKEN}`;
const payload = { idMessage: "7877cd439c05bc16617b", chatId: "maria@client.ru" };
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 . '/getThread/' . getenv('GRATIO_TOKEN');
$payload = ['idMessage' => '7877cd439c05bc16617b', 'chatId' => 'maria@client.ru'];
$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 — письмо Марии, ответ школы из «Отправленных» и снова Мария:
{
"threadId": "c62b698304229a98aad3",
"messages": [
{
"idMessage": "c62b698304229a98aad3", "folder": "INBOX", "uid": 1532, "uidValidity": 1700000000,
"chatId": "maria@client.ru", "messageId": "CAF1xQm7v2k@mail.gmail.com", "threadId": "c62b698304229a98aad3",
"inReplyTo": null, "references": [], "timestamp": 1791823658, "internalDate": 1791823661,
"from": {"address": "maria@client.ru", "name": "Мария"}, "to": [{"address": "info@school.ru", "name": ""}],
"cc": [], "replyTo": [], "subject": "Запись на пробное", "flags": ["\\Seen", "\\Answered"],
"seen": true, "flagged": false, "answered": true, "draft": false, "size": 4821, "hasAttachments": false
},
{
"idMessage": "db93a4558705f5b8ef5b", "folder": "Sent", "uid": 611, "uidValidity": 1700000001,
"chatId": "maria@client.ru", "messageId": "gr.ztme4rgc2femufilbicvmeimbh@school.ru", "threadId": "c62b698304229a98aad3",
"inReplyTo": "CAF1xQm7v2k@mail.gmail.com", "references": ["CAF1xQm7v2k@mail.gmail.com"],
"timestamp": 1791824858, "internalDate": 1791824860,
"from": {"address": "info@school.ru", "name": "Школа робототехники"}, "to": [{"address": "maria@client.ru", "name": ""}],
"cc": [], "replyTo": [], "subject": "Re: Запись на пробное", "flags": ["\\Seen"],
"seen": true, "flagged": false, "answered": false, "draft": false, "size": 3912, "hasAttachments": false
},
{
"idMessage": "7877cd439c05bc16617b", "folder": "INBOX", "uid": 1540, "uidValidity": 1700000000,
"chatId": "maria@client.ru", "messageId": "CAF1xQm9p4r@mail.gmail.com", "threadId": "c62b698304229a98aad3",
"inReplyTo": "gr.ztme4rgc2femufilbicvmeimbh@school.ru",
"references": ["CAF1xQm7v2k@mail.gmail.com", "gr.ztme4rgc2femufilbicvmeimbh@school.ru"],
"timestamp": 1791828458, "internalDate": 1791828460,
"from": {"address": "maria@client.ru", "name": "Мария"}, "to": [{"address": "info@school.ru", "name": ""}],
"cc": [], "replyTo": [], "subject": "Re: Запись на пробное", "flags": [],
"seen": false, "flagged": false, "answered": false, "draft": false, "size": 52817, "hasAttachments": true
}
]
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
threadId |
string | цепочка: idMessage её первого письма; null — писем не нашлось |
messages |
array | конверты писем от первого к последнему по дате — поля в статье Почта через API |
Где ищутся письма
Gratio ищет письма цепочки в папке указанного письма, во «Входящих», «Отправленных», «Архиве» и «Вся почта» — какие из этих папок есть в ящике. Письмо, которое лежит в нескольких папках, приходит один раз. Письма цепочки в других папках — например, перенесённые в «Заявки» — в ответ не попадут: укажите письмо из этой папки или найдите их searchMessages.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
не указано письмо; limit — не число |
исправить запрос |
400 |
not_found |
письма нет | указать folder и uid из getMessages |
400 |
folder_not_found |
нет папки folder |
проверить getFolders |
400 |
not_authorized |
ящик не подключён | подключить ящик: connectMailbox |
501 |
not_supported |
канал — не почта | вызвать у канала «Почта» |
Общие правила — в статье Ответы и ошибки.
Что дальше
- replyEmail — ответить в цепочку.
- getEmail — письмо целиком.
- Почта через API — чем чат отличается от цепочки.
