live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) livechat.reply jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
conversationId (path) | string | Igen | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
widget_id | string | Igen | — |
state | string<ai, waiting, open, offline, closed> | Igen | — |
visitor_name | string | Igen | — |
visitor_email | string | Igen | — |
page_url | string | Igen | — |
page_title | string | Igen | — |
referrer | string | Igen | — |
country | string | Igen | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Igen | — |
assigned_operator | string | Igen | — |
cursor | integer | Igen | — |
started_at | string | Igen | — |
last_message_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404