Beex Node for N8N

Este paquete contiene un nodo personalizado para n8n que permite interacturar con la API de Beex Contact Center, facilitando la automatización de flujos y procesos dentro del ecosistema Beex.

Beex Contact Center es una empresa peruana que ofrece una plataforma omnicanal impulsada por inteligencia artificial para optimizar la atención al cliente, ventas, marketing y cobranzas. Su software permite automatizar procesos mediante chatbots, IVR y workflows, integrando canales como llamadas, WhatsApp, redes sociales y correo electrónico, mejorando la eficiencia operativa y la experiencia del cliente

Instalación

Instalación en n8n

Para instalar este paquete en tu instancia de n8n:

1. Ve a Settings > Community Nodes > Install a Community Nodes
2. Busca n8n-nodes-beex e instálalo
3. Reinicia o Recarga n8n

Instalación manual

Para instalar el paquete de forma manual:

cd ~/.n8n/custom
npm install n8n-nodes-beex

Credenciales

Para conectarte a Beex, necesitarás emplear un Token de Acceso que deberás solicitar al momento de formar parte del ecosistema de Beex.

En n8n, puedes configurar tu credencial mediante los siguientes campos:

• TokenApp: Tu clave API de Beex
• API URL: https://api.beexcontact.com/api/v1 (La autenticación es por Header)

Funcionalidades

El nodo Beex permite realizar las siguientes operaciones:

Lista Negra

• Bloquear un Phone: Bloquea número de teléfonos seleccionados.
  • Requiere: ID País, Número de Teléfono, Observaciones, ID Canal, Lista de Canales de Cliente.

Llamadas

• Lanzar Llamada: Lanza una llamada a un cliente.
  • Requiere: ID Cliente, ID Usuario, ID Portfolio, Código de País, Número de Teléfono.

Clientes

• Obtener varios clients: Listar los contactos/clientes registrados en la plataforma. Se muestran de forma descendente.
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Crear Clientes: Crea contactos en la plataforma, indicando la campaña.
  • Requiere: ID Portfolio, Primer Nombre, Apellido Paterno, Apellido Materno, Número de Documento, Tipo de Documento, Fecha de Nacimiento, Edad, Sexo, Estado Civil, Posición Laboral, País (Código), Ciudad, Salario, Espacio de Trabajo.
  • Opcional: Campos Customizados, Filtros Customizados.
• Obtener varios accounts-fields: Obtener los campos de productos de un cliente.
  • Requiere: ID Cliente
  • Opcional: Ninguno
• Obtener varios accounts-values: Obtener los valores de productos de un cliente.
  • Requiere: ID Cliente
  • Opcional: Limit, Offset
• Obtener varios custom-fields: Obtener los campos personalizados de un cliente.
  • Requiere: ID Cliente
  • Opcional: Ninguno
• Obtener varios custom-values: Obtener los valores personalizados de un cliente.
  • Requiere: ID Cliente
  • Opcional: Ninguno

Empresas

• Obtener varios entities: Listar Empresas
  • Requiere: Ninguno
  • Opcional: Ninguno
• Crear una Empresa: Crear Empresas
  • Requiere: Nombre, tipo de industria, ruc, teléfono, correo electrónico, descripción, palabras clave.
• Obtener un entities: Obtener datos de una empresa
  • Requiere: ID Empresa
  • Opcional: Ninguno

Importaciones

• Obtener varios imports: Listar Grabaciones
  • Requiere: Ninguno
  • Opcional: Ninguno
• Recibir un Import: Recibe un archivo para importación de clientes y cuentas.
  • Requiere: Tipo de Importación, ID Portfolio, ID Empresa, Tipo de Asignación, ID Base, País (Código), Archivo de Importación.
• Recibir un Import Masivo: Recibe un archivo para importar masivamente datos a la plataforma.
  • Requiere: Tipo de Importación, ID Portfolio, ID Entidad, Tipo de Asignación, ID Base, País (Código), Archivo de Importación.
• Obtener varios import errors: Lista los errores de una importacion especifica
  • Requiere: ID Import
  • Opcional: Ninguno

Leads

• Crear un Lead: Crear un nuevo Lead
  • Requiere: Código de Cliente, ID Portfolio, ID Secuencia, Código de País, Número Telefónico, Email, Prioridad.
  • Parámetros: Primer Nombre, Apellido Paterno, Apellido Materno, Ciudad, País, Estado Civil.

PBX

• Obtener varios pbx: Listar Grabaciones
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
  • Campos Adicionales: Teléfono, Empresa, Portfolio, Hora Inicio, Hora Fin, Usuario, Tipo de Marcación, Disposición.
• Descargar un pbx: Descargar Grabaciones
  • Requiere: ID CDR
  • Opcional: Ninguno

Colas

• Obtener varios queues: Listar las colas creadas en la plataforma. Se muestran de forma descendente.
  • Requiere: Ninguno
  • Opcional: ID Portfolio, Limit, Offset
• Crear un queue: Crear un cola en la plataforma
  • Requiere: Nombre, Lista de Canales de Cliente, Lista de Usuarios, Umbral de Espera, Nivel de Servicio, Tipo de Distribución, Número de Tickets Máximo por Agente y Lista de Portfolios.
• Obtener un queues: Detalle de una cola en la plataforma.
  • Requiere: ID Cola
  • Opcional: Ninguno

Reportes

• Obtener reporte daily managments: Reporte de Atención al Cliente - Gestion diaria.
  • Requiere: ID Portfolio, Año, Mes
  • Opcional: Ninguno
• Obtener reporte dropped calls: Reporte de Atención al Cliente - Llamadas abandonadas.
  • Requiere: ID Portfolio, Año
  • Opcional: Ninguno
• Obtener reporte resumen: Reporte de Atención al Cliente - Resumen.
  • Requiere: ID Portfolio, Fecha
  • Opcional: Ninguno
• Obtener reporte time slot: Reporte de Atención al Cliente - Tramo Horario.
  • Requiere: ID Portfolio, ID Cola, Fecha Inicio, Fecha Fin
  • Opcional: Ninguno
• Obtener reporte users managements: Reporte de Atención al Cliente - Gestion de Usuarios.
  • Requiere: ID Portfolio, Año, Mes.
  • Opcional: Ninguno
• Obtener reporte calls: Reporte de Llamadas
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Obtener reporte client managements: Obtener información de tipificaciones por cliente.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Obtener reporte forms: Reporte de Formularios.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin, ID Formulario.
  • Opcional: Limit, Offset.
• Obtener reporte incoming call: Reporte de llamadas entrantes.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Obtener reporte ivr survey: Reporte de IVR tipo encuesta de satisfacción.
  • Requiere: Fecha Inicio, Fecha Fin, ID IVR
  • Opcional: Limit, Offset
• Obtener reporte log acw: Tipificaciones por log ACW.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin, ID Empresa
  • Opcional: ID Usuario, Limit, Offset
• Obtener reporte managements by acw: Tipificaciones por ACW.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: ID Usuario, Limit, Offset
• Obtener reporte managements per hour: Obtener información de tipificaciones por hora.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: ID Usuario, Limit, Offset.
• Obtener reporte messaging tickets: Reporte de tickets de mensajeria.
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Obtener reporte control pdp: Promesas de pago - Control PDP.
  • Requiere: ID Portfolio, Fecha Promesa de Pago
  • Opcional: Limit, Offset
• Obtener reporte list pdp: Promesas de pago - Listado PDP
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: ID Usuario, Limit, Offset
• Obtener reporte ranking pdp: Promesas de pago - Ranking PDP
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin, Tipo de Ranking.
  • Opcional: Limit, Offset
• Obtener reporte phones: Reporte de teléfonos.
  • Requiere: ID Empresa
  • Opcional: Limit, Offset
• Obtener reporte platform detailed: Tiempo en plataforma detallado.
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Obtener reporte platform summarized: Tiempo en plataforma sumarizado.
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Ninguno
• Obtener reporte product managements: Reporte de tipificaciones por producto.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Obtener reporte products: Reporte de productos.
  • Requiere: ID Portfolio
  • Opcional: Limit, Offset
• Obtener reporte progress managements: Obtener información del avance de gestiones.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: Ninguno
• Obtener reporte strategies: Reporte de estrategias.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin, Tipo de Estrategia
  • Opcional: Limit, Offset
• Obtener reporte tickets tracking: Reporte de transferencia de tickets.
  • Requiere: ID Portfolio, Fecha Inicio, Fecha Fin
  • Opcional: ID Cola, Limit, Offset

Secuencias

• Obtener varios sequences: Listar las secuencias configuradas.
  • Requiere: Ninguno
  • Opcional: Limit, Offset

Plantillas

• Obtener varios templates: Listar plantillas disponibles.
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: ID WABA, ID Cola, Limit, Offset
• Enviar un template: Dispara un mensaje de tipo Plantilla desde WABA (plantillas aprobadas)
  • Requiere: ID COla, Número de Teléfono, Nombre de la Plantilla, Código de País.
  • Opcional: Lista de valores de la plantilla, Archivo Binario, ID Usuario, Código de CLiente, Data Adicional del Cliente.

Tickets

• Obtener varios tickets: Listar los tickets generados.
  • Requiere: Fecha Inicio, Fecha Fin
  • Opcional: Limit, Offset
• Asignar Tag a un ticket: Asignar un Tag a un Ticket.
  • Requiere: Lista de Tickets, Código de Tag.
• Resolver un ticket: Resolver un Ticket si es que se encuentra activo en la plataforma.
  • Requiere: ID Ticket.
• Obtener varios tags: Listar etiquetas de tickets.
  • Requiere: Ninguno
  • Opcional: Limit, Offset
• Transferir un ticket: Transferir Ticket a agente
  • Requiere: Lista de Tickets, ID Usuario.
• Transferir un ticket a cola: Transferir Ticket a cola
  • Requiere: Lista de Tickets, ID Cola, ID Origen.
• Obtener un message: Obtener el detalle de un mensaje de ticket.
  • Requiere: ID Ticket
  • Opcional: Ninguno

Usuarios

• Obtener varios users: Listar usuarios registrados en la plataforma.
  • Requiere: Ninguno
  • Opcional: Búsqueda, Perfil, Limit, Offset

Formatos de Datos

Formato de Fechas

1. La mayoría de las funcionalidades del nodo requieren obligatoriamente una fecha de inicio y una fecha de fin.
2. El usuario puede seleccionar mediante un calendario una fecha en específica de formato AAAA-MM-DD HH:MM:SS
3. Según la necesidad del formato, el nodo internamente modificará el campo de fecha para adaptarla al formato adecuado, por ejemplo: AAAA-MM-DD o AAAA-MM-DD HH:MM

Soporte

Si experimentas percances o problemas con este nodo, por favor:

1. Verifica que el Token sea válido y posea los permisos adecuados. Recuerde solo agregar el token integro sin algún prefijo como: 'Token o Bearer'.
2. Comprueba que los formatos de datos sean los esperados (especialmente en las fechas).
3. Consulta la documentación de BeexCC para más detalles.

Licencia

MIT

Keywords

n8n-community-node-package beex

Más información

Consulta la documentación sobre la creación de nodos para obtener información detallada sobre cómo crear tus propios nodos.