public

GET /v1/public/chat/{publicKey}/config

What the chat widget on this site should look like.

ሁሉም የ public ማጠናቀቂያ ነጥቦች

developer ሰነዶች ሁሉ

ማረጋገጫ

ይህ ማቆሚያ (endpoint)ይፋዊ ነው። ምንም ምስክርነት (credential) ወይም ድርጅት አይወስድም — የራሳችን የግብይት ጣቢያ እና የAI መልስ ሞተሮች የሚያነቡት ነው።

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

ሞክሩት

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

curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/config

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

ዝርዝሮች

Anonymous — no credential, no tenant. The widget calls this to learn its greeting, colour, position and whether a person is likely to answer right now. The publicKey names a widget and authorises nothing: it ships in the page source of every site that embeds the widget, exactly like a publishable key. What actually gates the call is the Origin header, which must be one the customer listed on the widget. An unknown key, a disabled widget and an unlisted origin all answer 404 alike — which of the three it is is the customer's business, and distinguishing them would make this an oracle about other people's accounts. ⭐ The WordPress plugin never calls this: it already holds these settings server-side and inlines them into the page, so a WordPress visitor's browser makes no request at all until they open the chat.

መለኪያዎች

ስምዓይነትየሚያስፈልግምንነቱ
publicKey (path)stringአዎThe widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is…

ምላሽ

ስምዓይነትየሚያስፈልግምንነቱ
widget_idstringአዎ
team_namestringአይ
greetingstringአይ
accent_colourstringአይ
positionstring<left, right>አይ
brandingbooleanአዎWhether "Powered by Zinn® Chat" is shown. Decided by the TIER, not by the widget's own flag — a customer who downgrades stops hiding our mark without anybody editing their…
ai_enabledbooleanአይ
onlinebooleanአዎWhether a person is likely to answer, from the customer's declared business hours. Not operator presence: that would need the dashboard to hold a socket open, which this design…

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

404 · 429