live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda livechat.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
Requires `livechat.view` or `livechat.manage`.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
widgetId (path) | string | Bẹẹni | — |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
id | string | Bẹẹni | — |
site_id | string | Bẹẹni | — |
name | string | Bẹẹni | — |
public_key | string | Bẹẹni | — |
enabled | boolean | Bẹẹni | 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[] | Bẹẹni | 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 | Bẹẹni | — |
greeting | string | Bẹẹni | — |
team_name | string | Bẹẹni | — |
accent_colour | string | Bẹẹni | — |
position | string<left, right> | Bẹẹni | — |
hide_branding | boolean | Bẹẹni | — |
ai_enabled | boolean | Bẹẹni | — |
offline_email | string | Bẹẹni | — |
business_hours | object | Bẹẹkọ | — |
open_now | boolean | Bẹẹni | — |
ai_allowance | ChatAiAllowance | Bẹẹni | — |
limits | object | Bẹẹni | — |
premium_extra_code | string | Bẹẹni | The catalogue code to buy for the premium tier. |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404