Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie livechat.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako pole w treści JSON.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id | string | Nie | — |
site_id | string | Nie | — |
name | string | Tak | — |
team_name | string | Nie | — |
allowed_origins | string[] | Nie | — |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | string | Tak | — |
site_id | string | Tak | — |
name | string | Tak | — |
public_key | string | Tak | — |
enabled | boolean | Tak | 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[] | Tak | 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 | Tak | — |
greeting | string | Tak | — |
team_name | string | Tak | — |
accent_colour | string | Tak | — |
position | string<left, right> | Tak | — |
hide_branding | boolean | Tak | — |
ai_enabled | boolean | Tak | — |
offline_email | string | Tak | — |
business_hours | object | Nie | — |
open_now | boolean | Tak | — |
ai_allowance | ChatAiAllowance | Tak | — |
limits | object | Tak | — |
premium_extra_code | string | Tak | The catalogue code to buy for the premium tier. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 422