Iniciar sesiónContacto
Explorar la documentación

Referencia de la API

Referencia de la API

La API REST de CallShift, recurso por recurso. Cada petición acepta JSON, devuelve JSON y lleva tu clave de API.

URL basehttps://api.callshift.ai
AutenticaciónAuthorization: Bearer <API key> en cada ruta /v1. Consulta Autenticación.
ErroresUn código de estado HTTP y un cuerpo JSON. Consulta Errores.
Paginaciónpage, limit y pageCount. Consulta Paginación.
Legible por máquinaEspecificación OpenAPI 3.1 y Swagger UI, para generar un cliente o probar una petición.

Recursos

Las páginas de cada recurso están en inglés, el idioma de la especificación OpenAPI.

Agentes

Crea, duplica y configura agentes de voz, su flujo de llamada y su análisis tras la llamada.

GET/v1/agentsPOST/v1/agentsGET/v1/agents/{agentId}PATCH/v1/agents/{agentId}DELETE/v1/agents/{agentId}POST/v1/agents/{agentId}/duplicatePUT/v1/agents/{agentId}/webhook

Herramientas

Funciones que el agente invoca durante la llamada: tu endpoint, una búsqueda web, un SMS, un email.

GET/v1/toolsPOST/v1/toolsGET/v1/tools/{toolId}PATCH/v1/tools/{toolId}DELETE/v1/tools/{toolId}

Llamadas

Cada llamada con su resultado, resumen, transcripción, grabación y coste estimado.

GET/v1/callsGET/v1/calls/{callId}

Campañas

Llamadas salientes: contactos en cola, inicio y parada, reintentos.

GET/v1/campaignsPOST/v1/campaignsGET/v1/campaigns/{campaignId}PATCH/v1/campaigns/{campaignId}DELETE/v1/campaigns/{campaignId}POST/v1/campaigns/{campaignId}/contactsDELETE/v1/campaigns/{campaignId}/callsPOST/v1/campaigns/{campaignId}/retry

Contactos

Actualiza un contacto del CRM o da de baja un número (opt-out).

PATCH/v1/contact/{contactId}POST/v1/contact-opted-out

Números de teléfono

Los números de la cuenta y el agente que atiende cada uno.

GET/v1/phonesPATCH/v1/phones/{phoneId}PATCH/v1/phones/sip/{phoneId}DELETE/v1/phones/sip/{phoneId}GET/v1/phones/sipPOST/v1/phones/sip

Trunks SIP

Las conexiones con tu operador y su límite de llamadas por segundo.

GET/v1/trunks

Webhooks

Endpoints que reciben los datos de fin de llamada.

GET/v1/webhooksPOST/v1/webhooksGET/v1/webhooks/{webhookId}PATCH/v1/webhooks/{webhookId}DELETE/v1/webhooks/{webhookId}

Entidades

Unidades de la cuenta que agrupan agentes, números y webhooks.

GET/v1/entitiesPOST/v1/entitiesGET/v1/entities/{entityId}PATCH/v1/entities/{entityId}DELETE/v1/entities/{entityId}POST/v1/entities/{entityId}/move-items

Facturas

Las facturas de la cuenta y su historial de pagos.

GET/v1/invoices

Comprobación de estado

La única ruta pública, que no requiere clave de API: indica si la API y su base de datos están operativas.

GET
curl "https://api.callshift.ai/health"
const res = await fetch("https://api.callshift.ai/health");
const data = await res.json();
import requests

res = requests.get(
    "https://api.callshift.ai/health",
)
print(res.json())
Response
{
  "status": "healthy",
  "database": "connected"
}
{
  "status": "healthy",
  "database": "connected"
}