live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението livechat.reply; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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 | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404