public
POST /v1/public/chat/{publicKey}/conversations/{conversationId}/messages
The visitor says something else.
การยืนยันตัวตน
เอนด์พอยต์นี้เป็นสาธารณะ ไม่ต้องใช้ข้อมูลประจำตัวหรือองค์กรใดๆ เนื่องจากเป็นสิ่งที่เราใช้สำหรับเว็บไซต์การตลาดและระบบตอบคำถามด้วย AI ของเราเอง
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
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