ChatNeuron
Начать бесплатно
Разделы

справочник API · v1

Диалоги

Диалоги AI-сотрудников с клиентами во всех каналах: сайт, мессенджеры, телефон, приложения.

Ресурс Dialog

ПолеОписание
idstringId диалога.
agentIdstring | nullAI-сотрудник, который вёл диалог.
channelstringКанал: widget, telegram, max, vk, whatsapp, avito, email, phone, app и др.
statusstringОткрыт или закрыт (по завершении или после тишины). · одно из: open, closed
topicstring | nullТема диалога.
handedOffbooleanПередавался ли человеку.
resolvedboolean | nullРешён ли вопрос клиента; null — ещё не оценён.
startedAtstring (date-time)Первое сообщение.
lastMessageAtstring (date-time)Последнее сообщение.
closedAtstring | null (date-time)Когда закрыт.

Список диалогов

get/api/v1/dialogs

Диалоги с клиентами во всех каналах, новые первыми. Тестовые диалоги (проверка в кабинете) не отдаются.

Право ключа: Диалоги и переписка · dialogs:read

curl "https://app.chatneuron.ru/api/v1/dialogs?limit=50&since=2026-10-01T00%3A00%3A00Z" \
  -H "Authorization: Bearer cn_live_…"

Параметры запроса

ПараметрОписание
limitintegerСколько записей на странице. · 1–100 · по умолчанию 50
sincestring (date-time)Брать записи с этой даты (ISO 8601).
cursorstringnextCursor из прошлого ответа.

Ответ 200

Страница диалогов.

JSON
{
  "data": [
    {
      "id": "cmv8m4c2r0003ijkl",
      "agentId": "cmu3f9z7k0002efgh",
      "channel": "telegram",
      "status": "closed",
      "topic": "Доставка",
      "handedOff": false,
      "resolved": true,
      "startedAt": "2026-10-27T09:10:41.000Z",
      "lastMessageAt": "2026-10-27T09:16:12.000Z",
      "closedAt": "2026-10-27T09:46:12.000Z"
    }
  ],
  "nextCursor": null
}

Ошибки

СтатусcodeКогда
400invalid_requestНекорректные параметры или тело запроса.
401unauthorizedНет ключа, ключ неверный или отозван.
429rate_limitedБольше 120 запросов в минуту. Повторите через Retry-After секунд.

Диалог

get/api/v1/dialogs/{id}

Один диалог по id. Тестовые диалоги отвечают 404.

Право ключа: Диалоги и переписка · dialogs:read

curl https://app.chatneuron.ru/api/v1/dialogs/cmv8m4c2r0003ijkl \
  -H "Authorization: Bearer cn_live_…"

Параметры запроса

ПараметрОписание
idstring · обязателенId диалога.

Ответ 200

Диалог.

JSON
{
  "data": {
    "id": "cmv8m4c2r0003ijkl",
    "agentId": "cmu3f9z7k0002efgh",
    "channel": "telegram",
    "status": "closed",
    "topic": "Доставка",
    "handedOff": false,
    "resolved": true,
    "startedAt": "2026-10-27T09:10:41.000Z",
    "lastMessageAt": "2026-10-27T09:16:12.000Z",
    "closedAt": "2026-10-27T09:46:12.000Z"
  }
}

Ошибки

СтатусcodeКогда
401unauthorizedНет ключа, ключ неверный или отозван.
404not_foundНет такой записи в компании ключа.
429rate_limitedБольше 120 запросов в минуту. Повторите через Retry-After секунд.

Переписка диалога

get/api/v1/dialogs/{id}/messages

Реплики клиента, AI-сотрудника и сотрудников компании по порядку — старые первыми. Служебные сообщения не отдаются. Переписка, скрытая до оплаты тарифа, отвечает 403 locked.

Право ключа: Диалоги и переписка · dialogs:read

curl "https://app.chatneuron.ru/api/v1/dialogs/cmv8m4c2r0003ijkl/messages?limit=50" \
  -H "Authorization: Bearer cn_live_…"

Параметры запроса

ПараметрОписание
idstring · обязателенId диалога.
limitintegerСколько записей на странице. · 1–100 · по умолчанию 50
cursorstringnextCursor из прошлого ответа.

Ответ 200

Страница реплик.

JSON
{
  "data": [
    {
      "id": "cmv8m4c2r0010aaaa",
      "role": "client",
      "text": "Здравствуйте! Сколько доставка в Казань?",
      "authorName": null,
      "createdAt": "2026-10-27T09:10:41.000Z"
    },
    {
      "id": "cmv8m4c2r0011bbbb",
      "role": "ai",
      "text": "Здравствуйте! В Казань — 2–3 дня, 450 ₽. Оформить заказ?",
      "authorName": null,
      "createdAt": "2026-10-27T09:10:44.000Z"
    },
    {
      "id": "cmv8m4c2r0012cccc",
      "role": "operator",
      "text": "Анна, добрый день! Подскажу по срокам для вашего адреса.",
      "authorName": "Мария",
      "createdAt": "2026-10-27T09:13:02.000Z"
    }
  ],
  "nextCursor": null
}

Ошибки

СтатусcodeКогда
400invalid_requestНекорректные параметры или тело запроса.
401unauthorizedНет ключа, ключ неверный или отозван.
403lockedЗапись скрыта до оплаты тарифа.
404not_foundНет такой записи в компании ключа.
429rate_limitedБольше 120 запросов в минуту. Повторите через Retry-After секунд.

Дальше

Общие правила — ключи, лимиты, ошибки, страницы — в обзоре API. Узнавать о событиях сразу, без опроса, — через исходящие вебхуки.