Generar llamada

POST /api/v1/calls/originate

Este endpoint permite realizar una llamada al número enviado en la solicitud customer_number, de modo que se pueda establecer una comunicación con los agentes de una campaña/cola o el agente especificado.

En la respuesta la solicitud se dispone de una Identificación de la acción realizada el cual permite realizar la trazabilidad y así mismo para posteriores endpoints que lo soliciten.

ℹ Recuerda que:

La URL base para todas las solicitudes es: https://tu-dominio.c3.pe

Importante: reemplaza tu-dominio por el nombre de dominio específico que te haya proporcionado C3.

Solicitud

Cabeceras

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	✅ Sí	Token de autenticación (Bearer Token).

Cuerpo de la solicitud (Body)

Atributo	Tipo	Obligatorio	Descripción
customer_number	String	✅ Sí	Número del cliente a llamar.
campaign_id	Integer	✅ Sí	Identificador de la camapaña en la plataforma.
originate_first	String	✅ Sí	En proceso de llamada, a quien se le debe llamar primero, valores admitidos: CUSTOMER, AGENT
agent_username	String	❌ No	Permite especificar el agente con quien se establecerá la llamada.
ring_timeout	Integer	❌ No	Duración de tiempo de timbrado antes de colgar, por si el cliente no contesta, predeterminado 30 segundos.
call_group	Array	❌ No	Etiqueta para agrupar las llamadas generadas, por ejemplo: ventas_navidad, recordario_de_cita, etc.

Ejemplo de solicitud

POST /api/v1/calls/originate

El cuerpo de la solicitud debe enviarse en formato JSON e incluir los siguientes campos:

{
    "customer_number": "947209255",
    "campaign_id": 2,
    "originate_first": "CUSTOMER"
}

Respuesta

Respuesta Exitosa 200

{
    "message": "La solicitud se completó con éxito!",
	"data": {
        "actionid": "api_kdfdkjds4545454bkk4j35"
    }
}

Definición de atributos

Campo	Tipo	Descripción
message	String	Mensaje de respuesta del servidor.
data	Object	Objeto que contiene información básica de la generación de llamada.
data.actionid	String	Identicador de la acción realizada para generar la llamada.

Errores generales

Código HTTP	Tipo	Causa común
401	Unauthorized	El token de acceso no fue proporcionado en el encabezado Authorization, es inválido o ha sido revocado. Verifique que el token sea correcto y esté activo.
422	Unprocessable Entity	La solicitud fue entendida, pero contiene errores semánticos que impiden su procesamiento. Esto puede deberse a: 1. Parámetros faltantes o inválidos (ej, from_date no es una fecha válida); 2. Recurso inexistente (wa_number no registrado en el sistema); 3. Violación de reglas de negocio (el rango de fechas excede el límite permitido).
500	Server Error	Error interno del servidor. Intenta nuevamente más tarde o contacta soporte técnico.