live-chat

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

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

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن livechat.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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}