public
GET /v1/public/chat/{publicKey}/config
What the chat widget on this site should look like.
การยืนยันตัวตน
เอนด์พอยต์นี้เป็นสาธารณะ ไม่ต้องใช้ข้อมูลประจำตัวหรือองค์กรใดๆ เนื่องจากเป็นสิ่งที่เราใช้สำหรับเว็บไซต์การตลาดและระบบตอบคำถามด้วย AI ของเราเอง
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/configเข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
Anonymous — no credential, no tenant. The widget calls this to learn its greeting, colour, position and whether a person is likely to answer right now. The publicKey names a widget and authorises nothing: it ships in the page source of every site that embeds the widget, exactly like a publishable key. What actually gates the call is the Origin header, which must be one the customer listed on the widget. An unknown key, a disabled widget and an unlisted origin all answer 404 alike — which of the three it is is the customer's business, and distinguishing them would make this an oracle about other people's accounts. ⭐ The WordPress plugin never calls this: it already holds these settings server-side and inlines them into the page, so a WordPress visitor's browser makes no request at all until they open the chat.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
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… |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
widget_id | string | ใช่ | — |
team_name | string | ไม่ใช่ | — |
greeting | string | ไม่ใช่ | — |
accent_colour | string | ไม่ใช่ | — |
position | string<left, right> | ไม่ใช่ | — |
branding | boolean | ใช่ | Whether "Powered by Zinn® Chat" is shown. Decided by the TIER, not by the widget's own flag — a customer who downgrades stops hiding our mark without anybody editing their… |
ai_enabled | boolean | ไม่ใช่ | — |
online | boolean | ใช่ | Whether a person is likely to answer, from the customer's declared business hours. Not operator presence: that would need the dashboard to hold a socket open, which this design… |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
404 · 429