Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) livechat.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id | string | Nem | — |
site_id | string | Nem | — |
name | string | Igen | — |
team_name | string | Nem | — |
allowed_origins | string[] | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
site_id | string | Igen | — |
name | string | Igen | — |
public_key | string | Igen | — |
enabled | boolean | Igen | 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[] | Igen | 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 | Igen | — |
greeting | string | Igen | — |
team_name | string | Igen | — |
accent_colour | string | Igen | — |
position | string<left, right> | Igen | — |
hide_branding | boolean | Igen | — |
ai_enabled | boolean | Igen | — |
offline_email | string | Igen | — |
business_hours | object | Nem | — |
open_now | boolean | Igen | — |
ai_allowance | ChatAiAllowance | Igen | — |
limits | object | Igen | — |
premium_extra_code | string | Igen | The catalogue code to buy for the premium tier. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422