live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran livechat.reply; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
conversationId (path) | string | Ya | — |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | string | Ya | — |
widget_id | string | Ya | — |
state | string<ai, waiting, open, offline, closed> | Ya | — |
visitor_name | string | Ya | — |
visitor_email | string | Ya | — |
page_url | string | Ya | — |
page_title | string | Ya | — |
referrer | string | Ya | — |
country | string | Ya | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Ya | — |
assigned_operator | string | Ya | — |
cursor | integer | Ya | — |
started_at | string | Ya | — |
last_message_at | string | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404