Ir al contenido principal

Atom Cloud Functions: Base de Conocimientos de APIs Públicas

Conoce la URL base de las APIs de Atom, los formatos de autenticación requeridos y cómo utilizar correctamente los tokens según el módulo antes de comenzar tu integración.

URL base:

https://us-central1-atomchat-io.cloudfunctions.net

Guía de Autenticación: Leer antes de comenzar

Todas las APIs requieren un token en el encabezado Authorization. Existen dos formatos según el módulo:

Módulo

Tipo de Token

Formato del Encabezado

Templates

Authorization: Bearer <token-de-canal>

Calls, AI Agents, SIP, Voice Channels, WCI Webhook

Authorization: Bearer <uuid-token-empresa>

Clients, Webhooks, Typifications, Clients Import

Authorization: <uuid-token-empresa> (sin "Bearer")

⚠️ Nota de seguridad: El módulo Clients y los de consulta de configuración (Webhooks/Tipificaciones) usan el token sin el prefijo "Bearer". Si lo incluyes donde no corresponde, recibirás un error 401 Unauthorized.

1. Módulo: Templates (Plantillas WhatsApp)

¿Qué puedes lograr? Enviar mensajes automáticos aprobados por Meta, consultar detalles de plantillas o listar las disponibles en tu canal.


Enviar una Plantilla (POST /templates/)

Campo

Tipo

Requerido

Descripción

templateId

string

ID de la plantilla a enviar

phoneNumber

string

Número destino (formato internacional)

params

objeto

No

Variables de la plantilla (ej: {"nombre": "Juan"})

clientName

string

No

Nombre completo (no usar junto a firstName)

Referencia técnica (cURL):

cURL

curl -X POST https://us-central1-atomchat-io.cloudfunctions.net/templates/ \ -H "Authorization: Bearer <public-channel-token>" \ -H "Content-Type: application/json" \ -d '{"templateId": "id_123", "phoneNumber": "573001234567", "params": {"nombre": "Juan"}}'

2. Módulo: Clients (Gestión de Clientes)

¿Qué puedes lograr? Crear, buscar y consultar la información de tus contactos directamente desde tu CRM.

Crear un Nuevo Cliente (POST /clients/)

Campo

Requerido

Descripción

phone

Teléfono (mín. 8 dígitos, solo números)

optionals

Campos personalizados de tu empresa

name

Condicional

Nombre completo (no usar con firstName)

tags

No

Etiquetas (deben existir en Atom)

Referencia técnica (cURL):

cURL

curl -X POST https://us-central1-atomchat-io.cloudfunctions.net/clients/ \ -H "Authorization: <uuid-token-de-empresa>" \ -d '{"phone": "573001234567", "firstName": "Juan", "lastName": "Perez", "tags": ["vip"]}'

3 y 4. Módulo: Calls & AI Agents (Voz y Agentes IA)

¿Qué puedes lograr? Iniciar llamadas automáticas de WhatsApp donde un Agente de IA interactúa con el cliente.

Iniciar Llamada con IA (POST /calls/v1/)

Campo

Requerido

Descripción

aiAgentId

ID del agente de IA que hablará

conversationId

ID de la conversación asociada

5 y 6. Módulo: SIP Calls & Voice Channels

¿Qué puedes lograr? Realizar llamadas telefónicas tradicionales (SIP) desde tus sistemas.

Crear Llamada SIP (POST /calls/v1/sip/create)

Campo

Requerido

Descripción

voiceChannelId

ID del canal de voz a utilizar

toNumber

Número destino (ej: 573001234567)

7, 8, 9 y 10. Módulos de Integración y Configuración

Módulo

Endpoint

Propósito

Autenticación

Webhooks

GET /webhook/get-all

Listar integraciones activas

Sin Bearer

Typifications

GET /triggerTypificationWebhook/get-all

Obtener categorías de cierre

Sin Bearer

Import

POST /clientsImport/upload

Carga masiva (CSV/Excel)

Sin Bearer

WCI Webhook

POST /api/webhook/wci/

Capturar leads desde la web

Con Bearer

¿Ha quedado contestada tu pregunta?