live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास livechat.reply अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
Requires `livechat.reply`. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
conversationId (path) | string | हाँ | — |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
id | string | हाँ | — |
widget_id | string | हाँ | — |
state | string<ai, waiting, open, offline, closed> | हाँ | — |
visitor_name | string | हाँ | — |
visitor_email | string | हाँ | — |
page_url | string | हाँ | — |
page_title | string | हाँ | — |
referrer | string | हाँ | — |
country | string | हाँ | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | हाँ | — |
assigned_operator | string | हाँ | — |
cursor | integer | हाँ | — |
started_at | string | हाँ | — |
last_message_at | string | हाँ | — |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403 · 404