live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Նույնականացում
Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա livechat.reply թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:
Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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