Campanas

Campanas de llamadas y mensajeria salientes. Consulta detalles, estado y configuracion de tus campanas VoiceBot y Flow.

Endpoints

Metodo	Endpoint	Descripcion	Scope
GET	/campaigns	Listar campanas con filtros	campaigns:read
GET	/campaigns/{id}	Obtener una campana por ID	campaigns:read

Parametros de Consulta

Filtros disponibles para GET /campaigns

Parametro	Tipo	Descripcion
status	string	Filtrar por estado: Running, Paused, Completed
channelType	string	Filtrar por tipo de canal (ej., WhatsApp, Voice)
dateFrom	ISO 8601	Fecha de inicio para filtro de rango de fechas
dateTo	ISO 8601	Fecha de fin para filtro de rango de fechas
page	integer	Numero de pagina (por defecto: 1)
pageSize	integer	Elementos por pagina (por defecto: 25, maximo: 100)

Objeto Campaign

Campo	Tipo	Descripcion
id	string	Identificador unico de la campana
name	string	Nombre de la campana
description	string	Descripcion de la campana
type	string	VoiceBot \| Flow
status	string	Running \| Paused \| Completed
channelType	string	Canal utilizado para la campana
startDate	ISO 8601	Fecha de inicio de la campana
endDate	ISO 8601	Fecha de fin de la campana
createdAt	ISO 8601	Fecha y hora de creacion de la campana

Ejemplos de Solicitudes

Listar campanas en ejecucion:

curl https://api.auralytik.com/v1/campaigns?status=Running&page=1&pageSize=10 \
  -H "Authorization: Bearer YOUR_API_KEY"

Obtener una campana especifica:

curl https://api.auralytik.com/v1/campaigns/camp_789 \
  -H "Authorization: Bearer YOUR_API_KEY"

Ejemplo de Respuesta

{
  "data": [
    {
      "id": "camp_789",
      "name": "Q1 Outbound Sales",
      "description": "Outbound sales campaign targeting new leads",
      "type": "VoiceBot",
      "status": "Running",
      "channelType": "Voice",
      "startDate": "2024-01-15T00:00:00Z",
      "endDate": "2024-03-31T23:59:59Z",
      "createdAt": "2024-01-10T09:00:00Z"
    }
  ],
  "page": 1,
  "pageSize": 10,
  "totalCount": 8
}

Endpoints de gestion de campanas proximamente

APIs de creacion de campanas, controles de pausa/reanudacion y gestion de listas de contactos estan en desarrollo.

Solicitar Acceso API