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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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