#Цепочка переписки

GET /v1/mail/messages/:id/thread

Возвращает все письма цепочки переписки, к которой относится указанное письмо.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор любого письма из цепочки. Список: GET /v1/mail/messages

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/mail/messages/1763/thread" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/mail/messages/1763/thread" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/messages/1763/thread',
  {
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  }
)
const { success, data } = await res.json()
console.log(`Писем в цепочке: ${data.length}`)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/messages/1763/thread',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив писем цепочки, отсортированный по дате
data[].id number Идентификатор письма
data[].subject string Тема письма
data[].from string Отправитель в формате Имя <адрес>
data[].to string Получатель в формате Имя <адрес>
data[].cc string Копия письма; пустая строка "" когда копий нет
data[].date string Дата отправки в формате YYYY-MM-DD HH:MM:SS (без часового пояса)
data[].body string Полный текст письма с переносами строк (\r\n)

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1761,
      "subject": "Запрос по интеграции",
      "from": "Поддержка <support@example.com>",
      "to": "anna@example.com <anna@example.com>",
      "cc": "",
      "date": "2026-05-18 15:35:10",
      "body": "Здравствуйте! Уточните, пожалуйста, сроки по интеграции.\r\n\r\n-- \r\nС уважением, отдел поддержки"
    },
    {
      "id": 1763,
      "subject": "Re: Запрос по интеграции",
      "from": "Анна Иванова <anna@example.com>",
      "to": "Поддержка <support@example.com>",
      "cc": "",
      "date": "2026-05-18 15:35:32",
      "body": "Сроки устроят. Спасибо!"
    }
  ]
}

#Пример ответа при ошибке

404 — письмо не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `999999999` не найдена"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является положительным целым числом (сообщение: id must be a positive integer)
404 ENTITY_NOT_FOUND Письмо с указанным id не найдено
403 SCOPE_DENIED API-ключ не имеет скоупа mail
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
429 RATE_LIMITED Превышен лимит запросов (заголовок Retry-After: 2)
502 BITRIX_UNAVAILABLE Портал Битрикс24 вернул ошибку 5xx
422 BITRIX_ERROR Прочие ошибки Битрикс24
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 KEY_INACTIVE API-ключ деактивирован
401 KEY_EXPIRED Срок действия API-ключа истёк

Полный список общих ошибок API — Ошибки.

#Известные особенности

ID любого письма цепочки возвращает полную цепочку. Запрос с id любого участника переписки возвращает одинаковый полный набор писем.

#Смотрите также