live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението livechat.view; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Requires `livechat.view` or `livechat.manage`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
widgetId (path) | 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 · 404