Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin livechat.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Tempat ID organisasi Anda dimasukkan
Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.
ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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.
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
org_id | string | Tidak | — |
site_id | string | Tidak | — |
name | string | Ya | — |
team_name | string | Tidak | — |
allowed_origins | string[] | Tidak | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | string | Ya | — |
site_id | string | Ya | — |
name | string | Ya | — |
public_key | string | Ya | — |
enabled | boolean | Ya | 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[] | Ya | 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 | Ya | — |
greeting | string | Ya | — |
team_name | string | Ya | — |
accent_colour | string | Ya | — |
position | string<left, right> | Ya | — |
hide_branding | boolean | Ya | — |
ai_enabled | boolean | Ya | — |
offline_email | string | Ya | — |
business_hours | object | Tidak | — |
open_now | boolean | Ya | — |
ai_allowance | ChatAiAllowance | Ya | — |
limits | object | Ya | — |
premium_extra_code | string | Ya | The catalogue code to buy for the premium tier. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 422