live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu livechat.reply; ključ bez nje se odbija s kodom 403, a ne 404.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
conversationId (path) | string | Da | — |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | string | Da | — |
widget_id | string | Da | — |
state | string<ai, waiting, open, offline, closed> | Da | — |
visitor_name | string | Da | — |
visitor_email | string | Da | — |
page_url | string | Da | — |
page_title | string | Da | — |
referrer | string | Da | — |
country | string | Da | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Da | — |
assigned_operator | string | Da | — |
cursor | integer | Da | — |
started_at | string | Da | — |
last_message_at | string | Da | — |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404