live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie livechat.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
Requires livechat.view or livechat.manage.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
widgetId (path) | string | Tak | — |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | string | Tak | — |
site_id | string | Tak | — |
name | string | Tak | — |
public_key | string | Tak | — |
enabled | boolean | Tak | 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[] | Tak | 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 | Tak | 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> | Tak | 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 | Tak | The tier actually PAID for, independent of any hosting inclusion. |
greeting | string | Tak | — |
team_name | string | Tak | — |
accent_colour | string | Tak | — |
position | string<left, right> | Tak | — |
hide_branding | boolean | Tak | — |
ai_enabled | boolean | Tak | — |
offline_email | string | Tak | — |
business_hours | object | Nie | — |
open_now | boolean | Tak | — |
ai_allowance | ChatAiAllowance | Tak | — |
limits | object | Tak | — |
premium_extra_code | string | Tak | The catalogue code to buy for the premium tier. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404