live-chat

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

One chat's settings and its AI allowance.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास livechat.view अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…"

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

Requires livechat.view or livechat.manage.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`widgetId (path)`	`string`	हाँ	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`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 for…
`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…
`tier`	`string`	हाँ	The tier this widget is EFFECTIVELY on. Premium is included free with Zinn® hosting, so this may read `premium` on a widget nobody has paid for — read `purchased_tier` for what…
`tier_source`	`string<free, purchase, hosting>`	हाँ	Why the widget is on that tier. `hosting` means it is included with the customer's Zinn® hosting and there is nothing to buy; `purchase` means the Premium extra was bought for…
`purchased_tier`	`string`	हाँ	The tier actually PAID for, independent of any hosting inclusion.
`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

GET /v1/chat/widgets/{widgetId}