live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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