live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu livechat.view; ključ bez nje se odbija s kodom 403, a ne 404.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
Requires livechat.view or livechat.manage.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
widgetId (path) | string | Da | — |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | string | Da | — |
site_id | string | Da | — |
name | string | Da | — |
public_key | string | Da | — |
enabled | boolean | Da | 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[] | Da | 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 | Da | 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> | Da | 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 | Da | The tier actually PAID for, independent of any hosting inclusion. |
greeting | string | Da | — |
team_name | string | Da | — |
accent_colour | string | Da | — |
position | string<left, right> | Da | — |
hide_branding | boolean | Da | — |
ai_enabled | boolean | Da | — |
offline_email | string | Da | — |
business_hours | object | Ne | — |
open_now | boolean | Da | — |
ai_allowance | ChatAiAllowance | Da | — |
limits | object | Da | — |
premium_extra_code | string | Da | The catalogue code to buy for the premium tier. |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404