public
GET /v1/public/chat/{publicKey}/config
What the chat widget on this site should look like.
تصدیقهویت
دا پای ټکی عامه دی. دا هېڅ اعتبار او هېڅ سازمان ته اړتیا نه لري - دا هغه څه دي چې زموږ خپله د بازار موندنې پاڼه او د مصنوعي ځيرکتیا د ځواب انجنونه یې لولي.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/configننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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_id | string | هو | — |
team_name | string | نه | — |
greeting | string | نه | — |
accent_colour | string | نه | — |
position | string<left, right> | نه | — |
branding | boolean | هو | 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_enabled | boolean | نه | — |
online | boolean | هو | 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