live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya livechat.reply; ufunguo usio nayo unakataliwa kwa 403, si 404.
Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
conversationId (path) | string | Ndiyo | — |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
id | string | Ndiyo | — |
widget_id | string | Ndiyo | — |
state | string<ai, waiting, open, offline, closed> | Ndiyo | — |
visitor_name | string | Ndiyo | — |
visitor_email | string | Ndiyo | — |
page_url | string | Ndiyo | — |
page_title | string | Ndiyo | — |
referrer | string | Ndiyo | — |
country | string | Ndiyo | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Ndiyo | — |
assigned_operator | string | Ndiyo | — |
cursor | integer | Ndiyo | — |
started_at | string | Ndiyo | — |
last_message_at | string | Ndiyo | — |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404