live-chat

POST /v1/chat/conversations/{conversationId}/close

Close a conversation.

Toate punctele finale live-chat

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea livechat.reply; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
  -H "Authorization: Bearer zdk_live_…"

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.

Parametri

NumeTipObligatoriuCe este
conversationId (path)stringDa

Răspuns

NumeTipObligatoriuCe este
idstringDa
widget_idstringDa
statestring<ai, waiting, open, offline, closed>Da
visitor_namestringDa
visitor_emailstringDa
page_urlstringDa
page_titlestringDa
referrerstringDa
countrystringDaTwo-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
localestringDa
assigned_operatorstringDa
cursorintegerDa
started_atstringDa
last_message_atstringDa

Erori pe care le poate returna acest punct final

401 · 403 · 404