Producto
CLI

Widget web

Activa o desactiva el widget de chat web de un agente.

Activar o desactivar el widget

Activa el widget de chat web de un agente e imprime el <script> para instalarlo en tu sitio. Con --disable lo desactiva.

bash
01plazbot agent enable-widget <agentId> [options]

Parámetros

ParámetroFlagRequeridoDescripción
agentId(posicional)SíID del agente.
Desactivar-d, --disableNoDesactiva el widget en lugar de activarlo.
JSON--jsonNoImprime el resultado como JSON ({"id","widgetEnabled","script"}). Por defecto: false.

Ejemplos

bash
01# Activar el widget e imprimir el snippet <script>
02plazbot agent enable-widget age_AbcDef123
03 
04# Desactivar el widget
05plazbot agent enable-widget age_AbcDef123 --disable
06 
07# Guardar el snippet de instalación en un archivo
08plazbot agent enable-widget age_AbcDef123 --json | jq -r '.script' > widget.html

Resultado

text
01✔ Widget enabled for "Sales Plazbot"
02 
03 Installation
04 ────────────────────────────────────────
05 Paste this script inside the <head> tag of your website:
06 
07<script src="..."></script>

Al desactivar:

text
01✔ Widget disabled for "Sales Plazbot"

Salida JSON

json
01{
02 "id": "age_AbcDef123",
03 "widgetEnabled": true,
04 "script": "<script src=\"...\"></script>"
05}

script solo aparece al activar el widget (y si la API lo devuelve).

Los agentes copiados con copy o cross-copy empiezan con el widget desactivado.

Errores comunes

MensajeCausaSolución
The API rejected the request.La API respondió sin éxito y sin un mensaje propio.Revisa el agente con plazbot agent get age_AbcDef123.
Resource not found.El ID no existe en el workspace activo.Revisa el ID con plazbot agent list.
You are not signed in.No hay sesión activa.Ejecuta plazbot login.
¿Quieres probar la API en vivo? Abre el Playground.