Разговор целиком

Та же форма сообщений, что клиент собирает из живого потока. От идущего хода — вопрос последним сообщением с pending: true.

Доступ: chat.use.

Доступно по ключу API.

GET /v1/companies/{co}/chat/{id}

Разговор целиком

cURL

curl --request GET \
  --url https://api.tungo.kz/v1/companies/{co}/chat/{id} \
  --cookie tungo.session_token=

200

{
  "id": "6f1c2b9e-0000-4000-8000-000000000000",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "message_count": 123,
  "running": true,
  "turn": 123,
  "pd_restored": true,
  "messages": [
    {
      "role": "user",
      "id": "<string>",
      "text": "<string>",
      "at": "2023-11-07T05:31:56Z",
      "attachments": [
        {
          "name": "<string>",
          "media_type": "<string>",
          "size": 123
        }
      ],
      "mentions": [
        {
          "type": "proposal",
          "id": "P-000123",
          "title": "ТОО «Альфа»"
        }
      ],
      "pending": true
    }
  ],
  "masked": 123,
  "closed": {
    "reason": "context_overflow",
    "message": "<string>"
  },
  "awaiting": {
    "choice_id": "<string>",
    "questions": [
      {
        "question": "По какому договору провести оплату?",
        "header": "Договор",
        "options": [
          {
            "label": "<string>",
            "description": "<string>",
            "ref": "<string>"
          }
        ],
        "multi_select": true
      }
    ]
  }
}

Авторизации

sessionapiKeybearerKey

tungo.session_token · string · cookie · обязательно

Сессия кабинета: cookie ставит вход через /v1/auth/* (Better Auth), браузер шлёт её сам — фронтенду кабинета ничего добавлять не нужно (fetch с credentials: 'include'). За HTTPS имя cookie — __Secure-tungo.session_token. Сессия кончилась — 401 authentication_error: отправить на вход.

Параметры пути

co · string · обязательно

id компании, co_… — из GET /v1/companies

id · string · обязательно

id разговора: dialog_id из ответа (заголовок X-Dialog-Id, поле id в списке разговоров). Обычно UUID; клиент мог задать свой (до 64 знаков A–Z, a–z, 0–9, _ и -)

Пример:

"6f1c2b9e-0000-4000-8000-000000000000"

Ответ

200

application/json

Разговор

Разговор целиком

id · string · обязательно

id разговора (обычно UUID): по нему продолжают разговор (dialog_id), открывают его GET …/chat/{id} и стирают

Пример:

"6f1c2b9e-0000-4000-8000-000000000000"

title · string · обязательно

Заголовок — первый вопрос одной строкой

created_at · string<date-time> · обязательно

Когда начат разговор, ISO 8601 UTC

updated_at · string<date-time> · обязательно

Последнее изменение, ISO 8601 UTC

message_count · number · обязательно

Сколько сообщений в messages

running · boolean · обязательно

true — идёт ход: дочитать его потоком GET …/chat/{id}/events?turn=

turn · number · обязательно

Номер текущего хода (если идёт) или число законченных ходов

pd_restored · boolean · обязательно

false — персональные данные не раскрыты (сменился ключ шифрования): вместо БИН, имён и счетов в тексте метки вида «[ПД-БИН-1]». Показать предупреждение

messages · object[] · обязательно

Сообщения от старых к новым

Сообщение разговора: вопрос человека (role = user) или ответ ИИ (role = assistant)

Option 1

Option 2

Show child attributes

masked · number · обязательно

Сколько персональных данных (БИН, ИИН, имён, счетов) замаскировано в разговоре перед отправкой модели — для значка «данные скрыты»

closed · object

Разговор закрыт: продолжать нельзя (новое сообщение — 409 dialog_closed)

Show child attributes

awaiting · object

Открытый уточняющий вопрос: показать варианты; ответ — POST …/chat/{id}/answer

Show child attributes