live-chat

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

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

ದೃಢೀಕರಣ

ಬೇರರ್ ಟೋಕನ್ ಆಗಿ API ಕೀಯನ್ನು ಕಳುಹಿಸಿ. ಕೀಯು livechat.manage ಅನುಮತಿಯನ್ನು ಹೊಂದಿರಬೇಕು; ಅದನ್ನು ಹೊಂದಿರದ ಕೀಯನ್ನು 404 ಬದಲಿಗೆ 403 ನೊಂದಿಗೆ ತಿರಸ್ಕರಿಸಲಾಗುತ್ತದೆ.

ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ಯಾವುದೇ ಸಂಸ್ಥೆಯ ಐಡಿಯನ್ನು ತೆಗೆದುಕೊಳ್ಳುವುದಿಲ್ಲ. ನಿಮ್ಮ ಕೀ ಯು ಈಗಾಗಲೇ ಅದು ಸೇರಿರುವ ಸಂಸ್ಥೆಯನ್ನು ಗುರುತಿಸುತ್ತದೆ ಮತ್ತು ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ಅದಕ್ಕೆ ಸೀಮಿತಗೊಳಿಸಲಾಗಿದೆ.

ಪ್ರಯತ್ನಿಸಿ

ಕೋನೀಯ ಬ್ರಾಕೆಟ್‌ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್‌ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.

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

ಸೈನ್ ಇನ್ ಆಗಿದ್ದೀರಾ? ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ API ಕನ್ಸೋಲ್ ನಿಮ್ಮ ನೈಜ ಸಂಸ್ಥೆಯ ID ಮತ್ತು ನಿಮ್ಮ ಸ್ವಂತ ಕೀಲಿಯನ್ನು ಭರ್ತಿ ಮಾಡುತ್ತದೆ, ಮತ್ತು ಲೈವ್ API ವಿರುದ್ಧ ವಿನಂತಿಯನ್ನು ರನ್ ಮಾಡುತ್ತದೆ ಆದ್ದರಿಂದ ನೀವು ನಿಜವಾದ ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ನೋಡಬಹುದು. API ಕನ್ಸೋಲ್‌ನಲ್ಲಿ ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ತೆರೆಯಿರಿ

ವಿವರಗಳು

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.

ಪ್ಯಾರಾಮೀಟರ್‌ಗಳು

ಹೆಸರು	ಪ್ರಕಾರ	ಅಗತ್ಯವಿದೆ	ಏನಿದು
`widgetId (path)`	`string`	ಹೌದು	—

ಅನ್ವಯದ ದೇಹ

ಹೆಸರು	ಪ್ರಕಾರ	ಅಗತ್ಯವಿದೆ	ಏನಿದು
`name`	`string`	ಇಲ್ಲ	—
`enabled`	`boolean`	ಇಲ್ಲ	—
`allowed_origins`	`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`	ಇಲ್ಲ	—

ಪ್ರತಿಕ್ರಿಯೆ

ಹೆಸರು	ಪ್ರಕಾರ	ಅಗತ್ಯವಿದೆ	ಏನಿದು
`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 for…
`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…
`tier`	`string`	ಹೌದು	The tier this widget is EFFECTIVELY on. Premium is included free with Zinn® hosting, so this may read `premium` on a widget nobody has paid for — read `purchased_tier` for what…
`tier_source`	`string<free, purchase, hosting>`	ಹೌದು	Why the widget is on that tier. `hosting` means it is included with the customer's Zinn® hosting and there is nothing to buy; `purchase` means the Premium extra was bought for…
`purchased_tier`	`string`	ಹೌದು	The tier actually PAID for, independent of any hosting inclusion.
`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 · 422

PATCH /v1/chat/widgets/{widgetId}