live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл livechat.reply; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
conversationId (path) | string | Так | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
id | string | Так | — |
widget_id | string | Так | — |
state | string<ai, waiting, open, offline, closed> | Так | — |
visitor_name | string | Так | — |
visitor_email | string | Так | — |
page_url | string | Так | — |
page_title | string | Так | — |
referrer | string | Так | — |
country | string | Так | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Так | — |
assigned_operator | string | Так | — |
cursor | integer | Так | — |
started_at | string | Так | — |
last_message_at | string | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404