Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu livechat.manage; ključ bez nje se odbija s kodom 403, a ne 404.
Gdje dolazi ID vaše organizacije
Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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.
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
org_id | string | Ne | — |
site_id | string | Ne | — |
name | string | Da | — |
team_name | string | Ne | — |
allowed_origins | string[] | Ne | — |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | string | Da | — |
site_id | string | Da | — |
name | string | Da | — |
public_key | string | Da | — |
enabled | boolean | Da | 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[] | Da | 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 | Da | — |
greeting | string | Da | — |
team_name | string | Da | — |
accent_colour | string | Da | — |
position | string<left, right> | Da | — |
hide_branding | boolean | Da | — |
ai_enabled | boolean | Da | — |
offline_email | string | Da | — |
business_hours | object | Ne | — |
open_now | boolean | Da | — |
ai_allowance | ChatAiAllowance | Da | — |
limits | object | Da | — |
premium_extra_code | string | Da | The catalogue code to buy for the premium tier. |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 422