live-chat

GET `/v1/chat/widgets/{widgetId}`

One chat's settings and its AI allowance.

Tabbatar da Asali

Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin livechat.view; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.

Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…"

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

Requires `livechat.view` or `livechat.manage`.

Sigogi

Suna	Nau'i	Ana buƙata	Abin da yake
`widgetId (path)`	`string`	Eh	—

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`id`	`string`	Eh	—
`site_id`	`string`	Eh	—
`name`	`string`	Eh	—
`public_key`	`string`	Eh	—
`enabled`	`boolean`	Eh	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[]`	Eh	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`	Eh	—
`greeting`	`string`	Eh	—
`team_name`	`string`	Eh	—
`accent_colour`	`string`	Eh	—
`position`	`string<left, right>`	Eh	—
`hide_branding`	`boolean`	Eh	—
`ai_enabled`	`boolean`	Eh	—
`offline_email`	`string`	Eh	—
`business_hours`	`object`	A'a	—
`open_now`	`boolean`	Eh	—
`ai_allowance`	`ChatAiAllowance`	Eh	—
`limits`	`object`	Eh	—
`premium_extra_code`	`string`	Eh	The catalogue code to buy for the premium tier.

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 404

GET /v1/chat/widgets/{widgetId}