Producto
CLI

Ver Portal

Muestra el detalle de un portal: configuración, enlaces y agentes asociados

Ver un portal

Muestra la configuración completa de un portal a partir de su ID: datos generales, logos, enlaces y agentes asociados.

bash
01plazbot portal get <portalId> [--json]

Parámetros

ParámetroFlagRequeridoDescripción
Portal ID<portalId>SíID del portal (sale en plazbot portal list)
JSON--jsonNoImprime el portal en JSON

Ejemplos

bash
01# Ver el detalle de un portal
02plazbot portal get por_AbcDef123
03 
04# Obtener el portal en JSON
05plazbot portal get por_AbcDef123 --json
06 
07# Listar solo los agentes asociados
08plazbot portal get por_AbcDef123 --json | jq '.agents'

Resultado

text
01 Portal details
02 ────────────────────────────────────────
03 ID: por_AbcDef123
04 Name: Help Center
05 URL: https://la.plazbot.com/portal?id=por_AbcDef123&workspaceId=wok_AbcDef123
06 Access: direct
07 Status: Enabled
08 Title: ¿En qué podemos ayudarte?
09 Subtitle: Pregunta a nuestros agentes
10 Plazbot brand: Visible
11 
12 Assets
13 ────────────────────────────────────────
14 Logo: https://files.example.com/logo.png
15 Logo (dark mode): https://files.example.com/logo-dark.png
16 
17 Links
18 ────────────────────────────────────────
19 Docs: https://docs.example.com
20 Pricing: https://example.com/pricing
21 
22 Agents
23 ────────────────────────────────────────
24 Asistente de Ventas: age_AbcDef123

Las secciones Assets, Links y Agents solo aparecen si el portal tiene logos, enlaces o agentes.

Salida JSON

El objeto del portal tal como lo devuelve la API. Campos principales:

json
01{
02 "id": "por_AbcDef123",
03 "name": "Help Center",
04 "url": "https://la.plazbot.com/portal?id=por_AbcDef123&workspaceId=wok_AbcDef123",
05 "access": "direct",
06 "disabled": false,
07 "brandOff": false,
08 "title": "¿En qué podemos ayudarte?",
09 "subtitle": "Pregunta a nuestros agentes",
10 "logo": "https://files.example.com/logo.png",
11 "logodark": "https://files.example.com/logo-dark.png",
12 "links": [{ "value": "Docs", "url": "https://docs.example.com" }],
13 "agents": [{ "id": "age_AbcDef123", "name": "Asistente de Ventas" }]
14}

Errores comunes

MensajeCausaSolución
Resource not found.El ID no existe o es de otro workspaceRevisa el ID y el workspace activo con plazbot whoami
You are not signed in.No hay sesiónEjecuta plazbot login

Comandos relacionados

Para…Usa
Cambiar nombre, textos, logos o accesoplazbot portal update
Asociar o quitar un agenteplazbot portal add-agent · plazbot portal remove-agent
Agregar o quitar enlacesplazbot portal add-link · plazbot portal clear-links
¿Quieres probar la API en vivo? Abre el Playground.