live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit livechat.view ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
Requires `livechat.view` or `livechat.manage`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
widgetId (path) | string | Ha | — |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | string | Ha | — |
site_id | string | Ha | — |
name | string | Ha | — |
public_key | string | Ha | — |
enabled | boolean | Ha | 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[] | Ha | 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 | Ha | — |
greeting | string | Ha | — |
team_name | string | Ha | — |
accent_colour | string | Ha | — |
position | string<left, right> | Ha | — |
hide_branding | boolean | Ha | — |
ai_enabled | boolean | Ha | — |
offline_email | string | Ha | — |
business_hours | object | Yo'q | — |
open_now | boolean | Ha | — |
ai_allowance | ChatAiAllowance | Ha | — |
limits | object | Ha | — |
premium_extra_code | string | Ha | The catalogue code to buy for the premium tier. |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404