Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění livechat.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako pole v těle JSON.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id | string | Ne | — |
site_id | string | Ne | — |
name | string | Ano | — |
team_name | string | Ne | — |
allowed_origins | string[] | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
site_id | string | Ano | — |
name | string | Ano | — |
public_key | string | Ano | — |
enabled | boolean | Ano | 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[] | Ano | 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 | Ano | — |
greeting | string | Ano | — |
team_name | string | Ano | — |
accent_colour | string | Ano | — |
position | string<left, right> | Ano | — |
hide_branding | boolean | Ano | — |
ai_enabled | boolean | Ano | — |
offline_email | string | Ano | — |
business_hours | object | Ne | — |
open_now | boolean | Ano | — |
ai_allowance | ChatAiAllowance | Ano | — |
limits | object | Ano | — |
premium_extra_code | string | Ano | The catalogue code to buy for the premium tier. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422