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