live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen livechat.view; një çelës pa të refuzohet me 403, jo 404.
Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
Requires `livechat.view` or `livechat.manage`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
widgetId (path) | string | Po | — |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
id | string | Po | — |
site_id | string | Po | — |
name | string | Po | — |
public_key | string | Po | — |
enabled | boolean | Po | 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 fo… |
allowed_origins | string[] | Po | 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 a… |
tier | string | Po | — |
greeting | string | Po | — |
team_name | string | Po | — |
accent_colour | string | Po | — |
position | string<left, right> | Po | — |
hide_branding | boolean | Po | — |
ai_enabled | boolean | Po | — |
offline_email | string | Po | — |
business_hours | object | Jo | — |
open_now | boolean | Po | — |
ai_allowance | ChatAiAllowance | Po | — |
limits | object | Po | — |
premium_extra_code | string | Po | The catalogue code to buy for the premium tier. |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404