live-chat
PATCH /v1/chat/widgets/{widgetId}
Change a chat's settings, or switch it on.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ livechat.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
Requires livechat.manage. Switching a widget on with no allowedOrigins is refused with 422 rather than accepted: the widget only answers pages on origins the customer listed, so an empty list would leave the chat live, looking configured, and invisible on every page with nothing saying why.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
widgetId (path) | string | ใช่ | — |
เนื้อหาคำขอ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
name | string | ไม่ใช่ | — |
enabled | boolean | ไม่ใช่ | — |
allowed_origins | string[] | ไม่ใช่ | — |
greeting | string | ไม่ใช่ | — |
team_name | string | ไม่ใช่ | — |
accent_colour | string | ไม่ใช่ | — |
position | string<left, right> | ไม่ใช่ | — |
hide_branding | boolean | ไม่ใช่ | — |
ai_enabled | boolean | ไม่ใช่ | — |
offline_email | string | ไม่ใช่ | — |
business_hours | object | ไม่ใช่ | — |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
id | string | ใช่ | — |
site_id | string | ใช่ | — |
name | string | ใช่ | — |
public_key | string | ใช่ | — |
enabled | boolean | ใช่ | Whether the chat renders. Created FALSE always: the plugin ships in the deploy footprint of every WordPress site we host, so a widget may exist for a customer who never asked for… |
allowed_origins | string[] | ใช่ | Origins the widget may be embedded on. An EMPTY list refuses every page rather than allowing any — this is the only control stopping somebody else's site opening conversations… |
tier | string | ใช่ | The tier this widget is EFFECTIVELY on. Premium is included free with Zinn® hosting, so this may read premium on a widget nobody has paid for — read purchased_tier for what… |
tier_source | string<free, purchase, hosting> | ใช่ | Why the widget is on that tier. hosting means it is included with the customer's Zinn® hosting and there is nothing to buy; purchase means the Premium extra was bought for… |
purchased_tier | string | ใช่ | The tier actually PAID for, independent of any hosting inclusion. |
greeting | string | ใช่ | — |
team_name | string | ใช่ | — |
accent_colour | string | ใช่ | — |
position | string<left, right> | ใช่ | — |
hide_branding | boolean | ใช่ | — |
ai_enabled | boolean | ใช่ | — |
offline_email | string | ใช่ | — |
business_hours | object | ไม่ใช่ | — |
open_now | boolean | ใช่ | — |
ai_allowance | ChatAiAllowance | ใช่ | — |
limits | object | ใช่ | — |
premium_extra_code | string | ใช่ | The catalogue code to buy for the premium tier. |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 422