live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie livechat.reply beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
conversationId (path) | string | Ja | — |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Ja | — |
widget_id | string | Ja | — |
state | string<ai, waiting, open, offline, closed> | Ja | — |
visitor_name | string | Ja | — |
visitor_email | string | Ja | — |
page_url | string | Ja | — |
page_title | string | Ja | — |
referrer | string | Ja | — |
country | string | Ja | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Ja | — |
assigned_operator | string | Ja | — |
cursor | integer | Ja | — |
started_at | string | Ja | — |
last_message_at | string | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404