live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте 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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
conversationId (path) | string | Иә | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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