Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran livechat.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai medan dalam kandungan JSON.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka 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 log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
org_id | string | Tidak | — |
site_id | string | Tidak | — |
name | string | Ya | — |
team_name | string | Tidak | — |
allowed_origins | string[] | Tidak | — |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
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. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 422