v1

latestOpenAPI 3.0.32026-07-246376162.1 KB

Campaigns

Pause campaign

Pauses the specified dialer campaign.

post/api/v4/campaigns/{campaign_id}/pause

Path parameters

campaign_idinteger required

Example:1

The unique identifier of the campaign.

Response

idinteger

The unique identifier of the campaign.

namestring

The name of the campaign.

Current status of the campaign.

strategy'simple' | 'predictive_ai'

Dialing strategy used by the campaign.

dial_levelnumber float

Number of simultaneous calls per agent.

max_dial_timeinteger

Maximum dial time in seconds before hanging up.

max_wait_timeinteger

Maximum wait time in seconds for agent availability.

max_dial_attemptsinteger

Maximum number of dial attempts per lead.

amd_enabledboolean

Whether answering machine detection is enabled.

use_local_caller_idboolean

Whether to use local caller ID matching the lead's area.

asr_optimization_enabledboolean

Whether ASR (Answer Seizure Ratio) optimization is enabled.

allow_duplicate_numbersboolean

Whether the same phone number can be added to the campaign more than once.

follow_up_mode'timer' | 'lowest_attempts' nullable

Controls how the dialer prioritizes redial attempts within follow-up rules.

timer — contacts are prioritized strictly by their configured redial delay (default)
lowest_attempts — contacts with the fewest dial attempts are prioritized first, while still respecting redial delay timers

created_atstring date-time

Timestamp when the campaign was created (ISO 8601).

updated_atstring date-time

Timestamp when the campaign was last updated (ISO 8601).

Example response

{
  "id": 3,
  "name": "Summer Outreach Campaign",
  "status": "active",
  "strategy": "simple",
  "dial_level": 1,
  "dial_level_override": {
    "enabled": true,
    "value": 1.5,
    "active_agents_threshold": 3
  },
  "max_dial_time": 60,
  "max_wait_time": 5,
  "max_dial_attempts": 3,
  "voice_message": {
    "type": "voice_message",
    "name": "Instructions"
  },
  "amd_voicemail_message": {
    "voice_message": {
      "type": "voice_message",
      "name": "Instructions"
    }
  },
  "amd_enabled": true,
  "live": {
    "enabled": true,
    "dialing_order": "fifo"
  },
  "calling_list": {
    "method": "file_import"
  },
  "caller_id_sets": [
    {
      "phone_numbers": [
        "18885650001",
        "18885650002"
      ]
    }
  ],
  "asr_optimization_enabled": true,
  "follow_up_mode": "timer",
  "follow_up_rules": {
    "machine_answered": [
      {
        "type": "redial",
        "wait_time": 20,
        "wait_time_unit": "minutes",
        "actions": [
          {
            "type": "whatsapp",
            "channel_profile": {
              "id": 12,
              "channel": "whatsapp",
              "identifier": "18885658889",
              "name": "WhatsApp Main (18885658889)"
            },
            "whatsapp_template": {
              "id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
              "name": "Missed Call Follow-up"
            }
          }
        ]
      }
    ],
    "abandoned": [
      {
        "type": "redial",
        "wait_time": 20,
        "wait_time_unit": "minutes",
        "actions": [
          {
            "type": "whatsapp",
            "channel_profile": {
              "id": 12,
              "channel": "whatsapp",
              "identifier": "18885658889",
              "name": "WhatsApp Main (18885658889)"
            },
            "whatsapp_template": {
              "id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
              "name": "Missed Call Follow-up"
            }
          }
        ]
      }
    ],
    "no_answer": [
      {
        "type": "redial",
        "wait_time": 20,
        "wait_time_unit": "minutes",
        "actions": [
          {
            "type": "whatsapp",
            "channel_profile": {
              "id": 12,
              "channel": "whatsapp",
              "identifier": "18885658889",
              "name": "WhatsApp Main (18885658889)"
            },
            "whatsapp_template": {
              "id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
              "name": "Missed Call Follow-up"
            }
          }
        ]
      }
    ],
    "rejected": [
      {
        "type": "redial",
        "wait_time": 20,
        "wait_time_unit": "minutes",
        "actions": [
          {
            "type": "whatsapp",
            "channel_profile": {
              "id": 12,
              "channel": "whatsapp",
              "identifier": "18885658889",
              "name": "WhatsApp Main (18885658889)"
            },
            "whatsapp_template": {
              "id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
              "name": "Missed Call Follow-up"
            }
          }
        ]
      }
    ],
    "failed": [
      {
        "type": "redial",
        "wait_time": 20,
        "wait_time_unit": "minutes",
        "actions": [
          {
            "type": "whatsapp",
            "channel_profile": {
              "id": 12,
              "channel": "whatsapp",
              "identifier": "18885658889",
              "name": "WhatsApp Main (18885658889)"
            },
            "whatsapp_template": {
              "id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
              "name": "Missed Call Follow-up"
            }
          }
        ]
      }
    ],
    "busy": [
      {
        "type": "redial",
        "wait_time": 20,
        "wait_time_unit": "minutes",
        "actions": [
          {
            "type": "whatsapp",
            "channel_profile": {
              "id": 12,
              "channel": "whatsapp",
              "identifier": "18885658889",
              "name": "WhatsApp Main (18885658889)"
            },
            "whatsapp_template": {
              "id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
              "name": "Missed Call Follow-up"
            }
          }
        ]
      }
    ]
  },
  "post_call_rating": {
    "enabled": true,
    "notification_voice_message": {
      "type": "voice_message",
      "name": "Instructions"
    },
    "instructions_voice_message": {
      "type": "voice_message",
      "name": "Instructions"
    },
    "complete_voice_message": {
      "type": "voice_message",
      "name": "Instructions"
    }
  },
  "contact_local_time": {
    "start_time": "07:30",
    "end_time": "22:00",
    "days_of_week": [
      1,
      2,
      3,
      4,
      5
    ]
  },
  "created_at": "2026-01-15T10:30:00.123000Z",
  "updated_at": "2026-01-20T14:15:00.456000Z"
}