live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) livechat.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
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 GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"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.view` or `livechat.manage`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
widgetId (path) | string | Igen | — |
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 · 404