Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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 fo… |
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 a… |
tier | 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 | Не | — |
open_now | boolean | Да | — |
ai_allowance | ChatAiAllowance | Да | — |
limits | object | Да | — |
premium_extra_code | string | Да | The catalogue code to buy for the premium tier. |
Грешки, които този крайpoint може да върне
401 · 403 · 422