live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya livechat.view; ufunguo usio nayo unakataliwa kwa 403, si 404.
Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
Requires `livechat.view` or `livechat.manage`.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
widgetId (path) | string | Ndiyo | — |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
id | string | Ndiyo | — |
site_id | string | Ndiyo | — |
name | string | Ndiyo | — |
public_key | string | Ndiyo | — |
enabled | boolean | Ndiyo | 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[] | Ndiyo | 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 | Ndiyo | — |
greeting | string | Ndiyo | — |
team_name | string | Ndiyo | — |
accent_colour | string | Ndiyo | — |
position | string<left, right> | Ndiyo | — |
hide_branding | boolean | Ndiyo | — |
ai_enabled | boolean | Ndiyo | — |
offline_email | string | Ndiyo | — |
business_hours | object | Hapana | — |
open_now | boolean | Ndiyo | — |
ai_allowance | ChatAiAllowance | Ndiyo | — |
limits | object | Ndiyo | — |
premium_extra_code | string | Ndiyo | The catalogue code to buy for the premium tier. |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404