live-chat

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

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

ማረጋገጫ

የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የlivechat.manage ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (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 '{  }'

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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}