live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
စစ်မှန်ကြောင်း အတည်ပြုခြင်း
API သော့တစ်ခုကို bearer token အဖြစ် ပို့ပါ။ သော့တွင် livechat.view ခွင့်ပြုချက် ပါရှိရမည်ဖြစ်ပြီး၊ ၎င်းမပါရှိသော သော့ကို 404 အစား 403 ဖြင့် ငြင်းပယ်ပါမည်။
ဤ အမှတ်ဆက် (endpoint) သည် အဖွဲ့အစည်း အိုင်ဒီ (organisation id) ကို မယူပါ။ သင်၏ သော့ချက် (key) သည် ၎င်းပိုင်ဆိုင်သည့် အဖွဲ့အစည်းကို အလိုအလျောက် ဖော်ထုတ်ပြီးဖြစ်ကာ တုံ့ပြန်ချက်ကိုလည်း ၎င်းနှင့်သာ ကန့်သတ်ထားမည် ဖြစ်သည်။
စမ်းကြည့်ရန်
ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"ဝင်ရောက်ပြီးပြီလား။ သင့်ဒက်ရှ်ဘုတ်ရှိ API ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို 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 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