live-chat
POST /v1/chat/widgets
Create a chat for a site.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה livechat.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Requires livechat.manage. The new widget is created switched off: a chat window that starts talking to a customer's visitors before they have asked for one is a consent problem, not a feature.
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id | string | לא | — |
site_id | string | לא | — |
name | string | כן | — |
team_name | string | לא | — |
allowed_origins | string[] | לא | — |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
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 · 422