Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте livechat.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.
Сіздің ұйым идентификаторыңыз басқару панеліндегі 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.
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
org_id | string | Жоқ | — |
site_id | string | Жоқ | — |
name | string | Иә | — |
team_name | string | Жоқ | — |
allowed_origins | string[] | Жоқ | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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