Introducción

La API REST de SIP Caller permite que tus propias aplicaciones trabajen con tu cuenta de SIP Caller, de la misma manera en que lo haces desde la consola web. Úsala para conectar SIP Caller con tu CRM, ERP, mesa de ayuda o cualquier sistema interno, y automatizar de punta a punta tus operaciones de llamadas salientes.

Con la API puedes:

• Administrar campañas: crear, editar, duplicar y eliminar campañas, e iniciarlas, pausarlas o cancelarlas.
• Cargar números en las campañas: agregar números de a uno o de forma masiva, con los valores de variables que tus flujos de llamada y agentes de IA usan para personalizar cada llamada, o copiarlos desde una lista de contactos.
• Mantener tus listas sincronizadas: mantener las listas negras y las listas de contactos desde los sistemas donde residen esos datos.
• Leer resultados: obtener el detalle de cada llamada y de cada número de una campaña, para actualizar tus propios registros con el resultado.

La API se complementa con los webhooks, que notifican a tus sistemas en tiempo real cuando sucede algo en SIP Caller, como la activación de una campaña o la finalización de una llamada. Juntos, te permiten crear integraciones en las que las campañas se crean, se cargan y se monitorean sin trabajo manual.

La API REST y los webhooks están disponibles en los planes Enterprise de SIP Caller. Consulta los Precios para comparar los planes y sus funcionalidades.

URL base

Todos los endpoints descritos en esta referencia están disponibles en la siguiente URL base:

La API se sirve únicamente a través de HTTPS. La versión (v1) forma parte de la URL, y cualquier cambio no retrocompatible se publicará en una nueva versión, para que tu integración siga funcionando tal como está.

Solicitudes y respuestas

La API sigue las convenciones REST:

• Los recursos se identifican mediante URLs, y las acciones se expresan con los métodos HTTP estándar: GET para leer, POST para crear, PUT para actualizar y DELETE para eliminar.
• Los cuerpos de las solicitudes y las respuestas son JSON, codificados en UTF-8. Envía el encabezado Content-Type: application/json en cada solicitud que tenga un cuerpo JSON.
• Las solicitudes exitosas devuelven un código de estado 2xx. Los errores devuelven un código de estado 4xx o 5xx, con un cuerpo JSON que describe el problema, como se explica en Errores.
• Los identificadores son UUIDs (por ejemplo 01a0dedd-b9a2-729d-8e0a-4e3ad9197aea), excepto los números de las campañas, las listas negras y las listas de contactos, que se identifican con enteros.
• Las fechas usan el formato YYYY-MM-DD, y las marcas de tiempo usan el formato ISO 8601 sin zona horaria (por ejemplo 2026-09-26T17:57:48.064).

ID de la cuenta

Todos los endpoints corresponden a tu cuenta de SIP Caller, cuyo ID forma parte de la URL:

Puedes copiar el ID de tu cuenta desde la consola web, como se muestra a continuación.

Los IDs de otros recursos, como las campañas, se pueden obtener desde la propia API, o copiar desde la consola web:

Primeros pasos

1. Crea una API Key en la consola web, con los roles que necesita tu integración.
2. Lee cómo autenticar tus solicitudes.
3. Prueba el endpoint Listar campañas para comprobar que todo funciona.
4. Explora la referencia usando el menú de la izquierda. Cada endpoint incluye ejemplos listos para usar en cURL, Python, Java, Node.js y .NET: elige tu lenguaje en el panel de código, y tu elección se recordará en todas las páginas.

En los ejemplos, reemplaza API_KEY_TOKEN, ACCOUNT_ID y los demás marcadores en mayúsculas por tus propios valores.