live-chat

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

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

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग 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 कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ 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 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}