live-chat

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

One chat's settings and its AI allowance.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د livechat.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`widgetId (path)`	`string`	هو	—

ځواب

نوم	ډول	اړین	دا څه شی دی
`id`	`string`	هو	—
`site_id`	`string`	هو	—
`name`	`string`	هو	—
`public_key`	`string`	هو	—
`enabled`	`boolean`	هو	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[]`	هو	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`	هو	—
`greeting`	`string`	هو	—
`team_name`	`string`	هو	—
`accent_colour`	`string`	هو	—
`position`	`string<left, right>`	هو	—
`hide_branding`	`boolean`	هو	—
`ai_enabled`	`boolean`	هو	—
`offline_email`	`string`	هو	—
`business_hours`	`object`	نه	—
`open_now`	`boolean`	هو	—
`ai_allowance`	`ChatAiAllowance`	هو	—
`limits`	`object`	هو	—
`premium_extra_code`	`string`	هو	The catalogue code to buy for the premium tier.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404

GET /v1/chat/widgets/{widgetId}