live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Xaqiijinta aqoonsiga
U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda livechat.view; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.
Boggan ma qaato aqoonsiga ururka. Furahaagu wuxuu horay u aqoonsanayaa ururka uu ka tirsan yahay, jawaabtuna waxay ku kooban tahay halkaas.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Faahfaahin
Requires `livechat.view` or `livechat.manage`.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
widgetId (path) | string | Haa | — |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
id | string | Haa | — |
site_id | string | Haa | — |
name | string | Haa | — |
public_key | string | Haa | — |
enabled | boolean | Haa | 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[] | Haa | 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 | Haa | — |
greeting | string | Haa | — |
team_name | string | Haa | — |
accent_colour | string | Haa | — |
position | string<left, right> | Haa | — |
hide_branding | boolean | Haa | — |
ai_enabled | boolean | Haa | — |
offline_email | string | Haa | — |
business_hours | object | Maya | — |
open_now | boolean | Haa | — |
ai_allowance | ChatAiAllowance | Haa | — |
limits | object | Haa | — |
premium_extra_code | string | Haa | The catalogue code to buy for the premium tier. |
Cilladaha ay bartaani soo celin karto
401 · 403 · 404