public
POST /v1/public/chat/{publicKey}/conversations/{conversationId}/messages
The visitor says something else.
احراز هویت
این نقطه پایانی عمومی است. هیچ مدرک احراز هویت و هیچ سازمانی نمیپذیرد — این همان چیزی است که سایت بازاریابی خودمان و موتورهای پاسخدهنده هوش مصنوعی میخوانند.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/public/chat/{publicKey}/conversations/{conversationId}/messages \
-H "Content-Type: application/json" \
-d '{ "message": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Anonymous, authorised by X-Zinn-Chat-Token. The message is written to the database in this request, before any operator or assistant is involved — so nothing is lost when a consumer is down. A visitor writing into a conversation the operator had closed reopens it rather than being told it is over.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
publicKey (path) | string | بله | The widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is… |
conversationId (path) | string | بله | — |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
message | string | بله | — |
page_url | string | خیر | — |
page_title | string | خیر | — |
referrer | string | خیر | — |
locale | string | خیر | — |
name | string | خیر | — |
email | string | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
state | string<ai, waiting, open, offline, closed> | بله | — |
cursor | integer | بله | — |
poll_after_ms | integer | بله | How long the widget should wait before asking again. Decided by the SERVER on every response, because a cadence baked into the widget is cached on somebody else's site behind… |
messages | ChatMessage[] | بله | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
404 · 422 · 429