live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу livechat.view; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у 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 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 on. Since 2026-09-29 hosting includes no Premium, so this is the tier that was bought (the same value as purchased_tier). |
tier_source | string<free, purchase> | Да | Why the widget is on that tier: purchase means the Premium extra was bought for this site, free means it was not. (hosting was retired on 2026-09-29 with the hosting… |
purchased_tier | string | Да | The tier actually PAID for. |
greeting | string | Да | — |
team_name | string | Да | — |
accent_colour | string | Да | — |
position | string<left, right> | Да | — |
hide_branding | boolean | Да | — |
logo_url | string | Да | The uploaded logo, or empty. Shown here whatever the tier so the customer sees what is stored; visitors are served it only on Premium. |
ai_enabled | boolean | Да | — |
offline_email | string | Да | — |
business_hours | object | Не | — |
open_now | boolean | Да | Whether the chat currently reads as open. Opening hours are a Premium setting, so a free chat is always open whatever hours it has stored. |
ai_allowance | ChatAiAllowance | Да | — |
limits | object | Да | — |
premium_extra_code | string | Да | The catalogue code to buy for the premium tier. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404