Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar livechat.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
Requires `livechat.manage`. The new widget is created **switched off**: a chat window that starts talking to a customer's visitors before they have asked for one is a consent problem, not a feature.
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id | string | Hayır | — |
site_id | string | Hayır | — |
name | string | Evet | — |
team_name | string | Hayır | — |
allowed_origins | string[] | Hayır | — |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | — |
site_id | string | Evet | — |
name | string | Evet | — |
public_key | string | Evet | — |
enabled | boolean | Evet | 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[] | Evet | 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 | Evet | — |
greeting | string | Evet | — |
team_name | string | Evet | — |
accent_colour | string | Evet | — |
position | string<left, right> | Evet | — |
hide_branding | boolean | Evet | — |
ai_enabled | boolean | Evet | — |
offline_email | string | Evet | — |
business_hours | object | Hayır | — |
open_now | boolean | Evet | — |
ai_allowance | ChatAiAllowance | Evet | — |
limits | object | Evet | — |
premium_extra_code | string | Evet | The catalogue code to buy for the premium tier. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 422