ContactShip Node for n8n

Este paquete contiene un nodo para n8n que permite interactuar con la API de ContactShip.

ContactShip es una plataforma para crear agentes de IA que pueden realizar llamadas telefónicas de forma autónoma.

Instalación

Instalación en n8n

Para instalar este paquete en tu instancia de n8n:

1. Ve a Configuración > Paquetes de Nodos
2. Busca n8n-nodes-contactship e instálalo
3. Reinicia n8n

Instalación manual

Para instalar el paquete de forma manual:

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

Reinicia n8n para que los cambios tengan efecto.

Credenciales

Para conectarte a ContactShip, necesitarás una API Key que puedes obtener en el panel de control de ContactShip:

1. Crea una cuenta en ContactShip
2. Ve a Configuración > API Keys
3. Crea o copia una API Key existente

En n8n, configura una nueva credencial ContactShip API con los siguientes campos:

• API Key: Tu clave de API de ContactShip
• URL de la API: Por defecto es https://api.contactship.ai (no necesita modificación)

Funcionalidades

El nodo ContactShip permite realizar las siguientes operaciones:

Llamadas Telefónicas

• Hacer Llamada Telefónica AI: Iniciar una llamada telefónica desde un agente de IA a un número de teléfono.
  • Requiere: ID del Agente, Número de Origen, Número de Destino, Nombre Completo, País
  • Opcional: Email, Delay (en minutos), Datos Adicionales

Contactos

• Crear Contacto: Crear un nuevo contacto en ContactShip.

  • Requiere: Nombre Completo, Número de Teléfono, País
  • Opcional: Email, Descripción, Datos Adicionales

• Obtener Contacto: Obtener información de un contacto por ID, teléfono o email.

  • Requiere: Identificador del Contacto (ID, Teléfono o Email)

• Obtener Todos los Contactos: Listar todos los contactos con opciones de filtrado.

  • Opcional: Filtrar por Nombre, Email, Número de Teléfono

• Actualizar Contacto: Modificar información de un contacto existente.

  • Requiere: Identificador del Contacto
  • Opcional: Nombre Completo, Email, Descripción, Datos Adicionales

• Eliminar Contacto: Eliminar un contacto existente.

  • Requiere: Identificador del Contacto

• Obtener Historial de Llamadas: Ver el historial de llamadas de un contacto.

  • Requiere: Identificador del Contacto
  • Opcional: Filtros por Fecha, Dirección, Estado

• Añadir Comentario: Agregar un comentario a un contacto.

  • Requiere: Identificador del Contacto, Contenido del Comentario

• Obtener Comentarios: Ver todos los comentarios de un contacto.

  • Requiere: Identificador del Contacto

Agentes

• Obtener Todos los Agentes: Listar todos los agentes disponibles.

• Obtener Agente: Ver detalles de un agente específico.

  • Requiere: ID del Agente

• Actualizar Agente: Modificar la configuración de un agente.

  • Requiere: ID del Agente
  • Opcional: Nombre, Nombre de Persona, ID de Voz, Idioma, Sonido Ambiental, URL de Webhook, Propósito de Conversación, Prompt, Velocidad de Voz, Temperatura de Voz, Volumen, Sensibilidad de Interrupción

Créditos

• Obtener Créditos: Consultar los créditos disponibles en la cuenta.

Ejemplos de Uso

Ejemplo 1: Crear un contacto y luego realizar una llamada

1. Nodo ContactShip: Crear un contacto con información básica
2. Nodo ContactShip: Iniciar una llamada utilizando el ID de un agente existente

Ejemplo 2: Flujo de seguimiento de contactos

1. Nodo ContactShip: Obtener todos los contactos con un filtro específico
2. Nodo Set: Preparar los datos para comentarios
3. Nodo ContactShip: Añadir comentarios a los contactos filtrados

Ejemplo 3: Programar llamadas automáticas

1. Nodo Cron: Ejecutar el flujo periódicamente
2. Nodo ContactShip: Obtener contactos que necesitan seguimiento
3. Nodo Set: Preparar los datos para la llamada
4. Nodo ContactShip: Iniciar llamada AI automática (opcionalmente con delay para distribuir las llamadas)

Formatos de Datos

Formato de Número de Teléfono

Los números de teléfono deben estar en formato E.164, que incluye el código de país con un signo + al inicio, sin espacios ni símbolos adicionales.

Ejemplo: +12124567890

Datos Adicionales

Los datos adicionales se pueden usar tanto para contactos como para llamadas:

• Para Contactos: Se pueden especificar datos estructurados como Texto, URL, Ubicación, Número o Calendario
• Para Llamadas: Se pueden enviar datos en formato clave-valor que estarán disponibles para el agente durante la llamada

Opciones de Configuración de Llamadas

• Delay: Permite programar un retraso en minutos antes de que se realice la llamada (útil para programar llamadas futuras)

Soporte

Si tienes problemas con este nodo, por favor:

1. Verifica que la API Key sea válida y tenga los permisos correctos
2. Comprueba que los formatos de datos sean los esperados (especialmente los números de teléfono)
3. Consulta la documentación de ContactShip para más detalles

Licencia

Este proyecto se distribuye bajo la licencia MIT.

Desarrollo

Si deseas contribuir o modificar este nodo, sigue estos pasos:

1. Clona este repositorio

git clone https://github.com/contactship/n8n-nodes-contactship.git

2. Instala las dependencias

cd n8n-nodes-contactship
npm install

3. Compila el código

npm run build

4. Enlaza el paquete para desarrollo

npm link

5. En tu instalación de n8n, enlaza el paquete

cd /path/to/n8n
npm link n8n-nodes-contactship

Soporte

Si necesitas ayuda o encuentras algún problema, por favor abre un issue en el repositorio de GitHub o contacta al soporte de ContactShip.