Dials API

Authentication

All API requests must include a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY_HERE

If the key is missing, invalid, or of the wrong type, the server will return a 401 Unauthorized or 403 Forbidden response.

Base URL

https://api.outboundiq.cloud

Endpoints

Post Dial

Sends a single dial record to outboundIQ for processing and enrichment.

Method: POST
URL: /dials
Headers:
- Authorization: Bearer YOUR_API_KEY_HERE
- Content-Type: application/json

Body Schema:

type Payload = {
  // Your internal campaign identifier
  campaign_id: string;

  // Human-readable campaign name
  campaign_name: string;

  // The agent who handled the call
  agent_name: string;

  // The outbound caller ID (the number you dialed FROM)
  ani: string;

  // The disposition / call result
  disposition_name: string;

  // The prospect / customer phone number (the number you dialed TO)
  prospect_phone: string;

  // Call timestamp in UTC, format: YYYY-MM-DD HH:MM:SS (or ISO 8601)
  datetime: string;

  // One of: Inbound, Outbound, SMS, Treview, Transfer, Manual, etc.
  call_direction: string;

  // US zip code (5 digits preferred)
  zip: string;

  // Lead creation date, format: YYYY-MM-DD
  sys_created_date_original: string;

  // Total number of dial attempts on this record
  total_dial_attempts: string | number;

  // Skill name / team name / queue / etc.
  skill_name: string;

  // Lead source code / identifier / URL
  lead_source: string;

  // Dial ID / Conversation ID
  dial_id?: string;
};

Body Example:

{
  "campaign_id": "abc-123",
  "campaign_name": "Q2 Outbound Push",
  "agent_name": "Jane Doe",
  "ani": "5551234567",
  "disposition_name": "Sale",
  "prospect_phone": "5559876543",
  "datetime": "2026-04-10 14:32:15",
  "call_direction": "Outbound",
  "zip": "90210",
  "sys_created_date_original": "2026-04-01",
  "total_dial_attempts": 3,
  "skill_name": "Sales Tier 1",
  "lead_source": "facebook-ads",
  "dial_id": "550e8400-e29b-41d4-a716-446655440000"
}

Success Response:

{
  "message": "dial queued"
}

Example

curl -X POST \
  https://api.outboundiq.cloud/dials \
  -H 'Authorization: Bearer YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_id": "abc-123",
    "campaign_name": "Q2 Outbound Push",
    "agent_name": "Jane Doe",
    "ani": "5551234567",
    "disposition_name": "Sale",
    "prospect_phone": "5559876543",
    "datetime": "2026-04-10 14:32:15",
    "call_direction": "Outbound",
    "zip": "90210",
    "sys_created_date_original": "2026-04-01",
    "total_dial_attempts": 3,
    "skill_name": "Sales Tier 1",
    "lead_source": "facebook-ads",
    "dial_id": "550e8400-e29b-41d4-a716-446655440000"
  }'