live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь livechat.view эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Энэ төгсгөл цэг нь ямар ч байгууллагын 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 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> | Тийм | 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 | Тийм | The tier actually PAID for, independent of any hosting inclusion. |
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. |
Энэ төгсгөл цэгээс буцааж болох алдаанууд
401 · 403 · 404