Campaigns

Outbound calling and messaging campaigns. Retrieve campaign details, status, and configuration for your VoiceBot and Flow campaigns.

Endpoints

Method	Endpoint	Description	Scope
GET	/campaigns	List campaigns with filters	campaigns:read
GET	/campaigns/{id}	Get a single campaign by ID	campaigns:read

Query Parameters

Available filters for GET /campaigns

Parameter	Type	Description
status	string	Filter by status: Running, Paused, Completed
channelType	string	Filter by channel type (e.g., WhatsApp, Voice)
dateFrom	ISO 8601	Start date for date range filter
dateTo	ISO 8601	End date for date range filter
page	integer	Page number (default: 1)
pageSize	integer	Items per page (default: 25, max: 100)

Campaign Object

Field	Type	Description
id	string	Unique campaign identifier
name	string	Campaign name
description	string	Campaign description
type	string	VoiceBot \| Flow
status	string	Running \| Paused \| Completed
channelType	string	Channel used for the campaign
startDate	ISO 8601	Campaign start date
endDate	ISO 8601	Campaign end date
createdAt	ISO 8601	Timestamp when the campaign was created

Example Requests

List running campaigns:

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

Get a specific campaign:

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

Example Response

{
  "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
}

Campaign management endpoints coming soon

Campaign creation, pause/resume controls, and contact list management APIs are being developed.

Request API Access