live-chat

PATCH /v1/chat/widgets/{widgetId}

Change a chat's settings, or switch it on.

ሁሉም የ live-chat ማጠናቀቂያ ነጥቦች

developer ሰነዶች ሁሉ

ማረጋገጫ

የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የlivechat.manage ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

curl -X PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በAPI ኮንሶል ውስጥ ይክፈቱ

ዝርዝሮች

Requires livechat.manage. Switching a widget on with no allowedOrigins is refused with 422 rather than accepted: the widget only answers pages on origins the customer listed, so an empty list would leave the chat live, looking configured, and invisible on every page with nothing saying why.

መለኪያዎች

ስምዓይነትየሚያስፈልግምንነቱ
widgetId (path)stringአዎ

የጥያቄ አካል

ስምዓይነትየሚያስፈልግምንነቱ
namestringአይ
enabledbooleanአይ
allowed_originsstring[]አይ
greetingstringአይ
team_namestringአይ
accent_colourstringአይ
positionstring<left, right>አይ
hide_brandingbooleanአይ
ai_enabledbooleanአይ
offline_emailstringአይ
business_hoursobjectአይ

ምላሽ

ስምዓይነትየሚያስፈልግምንነቱ
idstringአዎ
site_idstringአዎ
namestringአዎ
public_keystringአዎ
enabledbooleanአዎ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_originsstring[]አዎ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…
tierstringአዎ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_sourcestring<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_tierstringአዎThe tier actually PAID for, independent of any hosting inclusion.
greetingstringአዎ
team_namestringአዎ
accent_colourstringአዎ
positionstring<left, right>አዎ
hide_brandingbooleanአዎ
ai_enabledbooleanአዎ
offline_emailstringአዎ
business_hoursobjectአይ
open_nowbooleanአዎ
ai_allowanceChatAiAllowanceአዎ
limitsobjectአዎ
premium_extra_codestringአዎThe catalogue code to buy for the premium tier.

ይህ ማብቂያ ሊመልሳቸው የሚችሉ ስህተቶች

401 · 403 · 404 · 422