live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na livechat.reply; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
conversationId (path) | string | Oo | — |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | string | Oo | — |
widget_id | string | Oo | — |
state | string<ai, waiting, open, offline, closed> | Oo | — |
visitor_name | string | Oo | — |
visitor_email | string | Oo | — |
page_url | string | Oo | — |
page_title | string | Oo | — |
referrer | string | Oo | — |
country | string | Oo | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Oo | — |
assigned_operator | string | Oo | — |
cursor | integer | Oo | — |
started_at | string | Oo | — |
last_message_at | string | Oo | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404