live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს livechat.reply ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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