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 കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് 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 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 · 422

PATCH /v1/chat/widgets/{widgetId}