live-chat

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

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

அங்கீகாரம்

பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை livechat.manage அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.

இந்த எண்ட்பாயிண்டிற்கு எந்த அமைப்பு ஐடியும் (organisation id) தேவையில்லை. உங்கள் விசை (key) அது எந்த அமைப்புக்குரியது என்பதை ஏற்கனவே அடையாளம் காட்டுகிறது, மேலும் பதிலானது அதற்கேற்ப வரம்பிடப்பட்டுள்ளது.

முயன்று பார்

கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.

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

உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்

விவரங்கள்

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}