live-chat

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

Change a chat's settings, or switch it on.

Autentifikatsiya

API kalitini bearer token sifatida yuboring. Kalit livechat.manage ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.

Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.

Sinab ko'rish

Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.

curl -X PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching

Tafsilotlar

Requires `livechat.manage`. Switching a widget on with no `allowedOrigins` is refused with `422` rather than accepted: the widget only answers pages on origins the customer listed, so an empty list would leave the chat live, looking configured, and invisible on every page with nothing saying why.

Parametrlar

Nomi	Turi	Majburiy	Nima bu
`widgetId (path)`	`string`	Ha	—

Soʻrov tanasi

Nomi	Turi	Majburiy	Nima bu
`name`	`string`	Yo'q	—
`enabled`	`boolean`	Yo'q	—
`allowed_origins`	`string[]`	Yo'q	—
`greeting`	`string`	Yo'q	—
`team_name`	`string`	Yo'q	—
`accent_colour`	`string`	Yo'q	—
`position`	`string<left, right>`	Yo'q	—
`hide_branding`	`boolean`	Yo'q	—
`ai_enabled`	`boolean`	Yo'q	—
`offline_email`	`string`	Yo'q	—
`business_hours`	`object`	Yo'q	—

Javob

Nomi	Turi	Majburiy	Nima bu
`id`	`string`	Ha	—
`site_id`	`string`	Ha	—
`name`	`string`	Ha	—
`public_key`	`string`	Ha	—
`enabled`	`boolean`	Ha	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[]`	Ha	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`	Ha	—
`greeting`	`string`	Ha	—
`team_name`	`string`	Ha	—
`accent_colour`	`string`	Ha	—
`position`	`string<left, right>`	Ha	—
`hide_branding`	`boolean`	Ha	—
`ai_enabled`	`boolean`	Ha	—
`offline_email`	`string`	Ha	—
`business_hours`	`object`	Yo'q	—
`open_now`	`boolean`	Ha	—
`ai_allowance`	`ChatAiAllowance`	Ha	—
`limits`	`object`	Ha	—
`premium_extra_code`	`string`	Ha	The catalogue code to buy for the premium tier.

Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}