live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung livechat.reply verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
conversationId (path) | string | Ja | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
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 | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404