live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso livechat.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Requires `livechat.view` or `livechat.manage`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
widgetId (path) | string | Sí | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | string | Sí | — |
site_id | string | Sí | — |
name | string | Sí | — |
public_key | string | Sí | — |
enabled | boolean | Sí | 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[] | Sí | 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 | Sí | — |
greeting | string | Sí | — |
team_name | string | Sí | — |
accent_colour | string | Sí | — |
position | string<left, right> | Sí | — |
hide_branding | boolean | Sí | — |
ai_enabled | boolean | Sí | — |
offline_email | string | Sí | — |
business_hours | object | No | — |
open_now | boolean | Sí | — |
ai_allowance | ChatAiAllowance | Sí | — |
limits | object | Sí | — |
premium_extra_code | string | Sí | The catalogue code to buy for the premium tier. |
Errores que este endpoint puede devolver
401 · 403 · 404