live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
ማረጋገጫ
የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የlivechat.view ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።
ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።
ሞክሩት
በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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