live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה livechat.reply; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
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