live-chat
PATCH /v1/chat/widgets/{widgetId}
Change a chat's settings, or switch it on.
প্রমাণীকরণ
একটি বিয়ারার টোকেন হিসেবে একটি এপিআই কি পাঠান। কি-টির অবশ্যই livechat.manage অনুমতি থাকতে হবে; এটি ছাড়া কোনো কি ৪০৪ নয়, বরং ৪০৩ ত্রুটি দিয়ে প্রত্যাখ্যাত হবে।
এই এন্ডপয়েন্টটি কোনো অর্গানাইজেশন আইডি নেয় না। আপনার কীটি ইতিমধ্যে এটি যে অর্গানাইজেশনের অন্তর্গত তা শনাক্ত করে এবং প্রতিক্রিয়াটি সেই অনুযায়ী নির্ধারিত হয়।
চেষ্টা করুন
কোণ বন্ধনীতে থাকা যেকোনো কিছু আপনার নিজস্ব মান দিয়ে এবং কী প্লেসহোল্ডারটি আপনার ড্যাশবোর্ডের একটি কী দিয়ে প্রতিস্থাপন করুন।
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 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 · 422