assistant

GET /v1/assistant/conversations/{conversationId}

Read one conversation with its full thread.

Усі кінцеві точки assistant

Уся документація для розробників

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/assistant/conversations/{conversationId} \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

⛔ A colleague's conversation is a 404, never a 403 — a 403 confirms the id exists, which is itself information about what a colleague has asked.

Параметри

НазваТипОбов'язковеЩо це таке
conversationId (path)UuidТакThe conversation's id.

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringТакThe first question, truncated, so a list of threads is readable.
escalated_ticket_idUuidТакSet once this thread became a support ticket.
created_atstringТак
updated_atstringТак
messagesAssistantMessage[]Так
proposalsAgentProposal[]ТакActions the assistant suggested in this thread. Nothing here has happened — a proposal is a suggestion with a confirm button, and it is applied only by…

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429