live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění livechat.reply; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
conversationId (path) | string | Ano | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
widget_id | string | Ano | — |
state | string<ai, waiting, open, offline, closed> | Ano | — |
visitor_name | string | Ano | — |
visitor_email | string | Ano | — |
page_url | string | Ano | — |
page_title | string | Ano | — |
referrer | string | Ano | — |
country | string | Ano | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Ano | — |
assigned_operator | string | Ano | — |
cursor | integer | Ano | — |
started_at | string | Ano | — |
last_message_at | string | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404