VOvoiso
Campaigns

Get list of campaigns

Changed on

Returns a paginated list of all dialer campaigns.

get/api/v4/campaigns

Request

Query parameters

limitinteger

The number of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

namestring
Example:Summer Outreach Campaign

A campaign name.

'advanced' | 'simple' | 'predictive_ai'
OR
string[]

Filter by strategy. Accepts a single value or an array.

'draft' | 'active' | 'paused' | 'stopping' | 'completed' | 'processing' | 'stopped' | 'auto_paused' | 'pausing' | 'auto_pausing' | 'import_error' | 'deactivating'
OR
string[]

Filter by status. Accepts a single value or an array.

'file_import' | 'bitrix_crm' | 'falcon_crm' | 'hubspot_crm' | 'panda_crm' | 'salesforce_crm' | 'zoho_crm' | 'zenoti_crm' | 'leverate_crm' | 'getlogic_crm'
OR
string[]

Filter by method. Accepts a single value or an array.

liveboolean
Example:true

Whether or not the campaign type is live.

Response

OK

Example response

{
  "campaigns": [
    {
      "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,
      "amd_comfort_noise_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"
                }
              }
            ]
          }
        ],
        "wrapup_code": [
          {
            "type": "redial",
            "wrapup_code": {
              "id": 1,
              "name": "Issue Resolved",
              "code": "0002"
            },
            "wait_time": 20,
            "wait_time_unit": "minutes"
          }
        ]
      },
      "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"
    }
  ],
  "metadata": {
    "total": 100
  }
}

Changes

  • 5a6ea146bd21Revision changes
    • breaking

      for the query request parameter limit, the max was decreased from 1000.00 to 100.00

    • warning

      added the new deactivating enum value to the // response property for the response status

    • warning

      added the new getlogic_crm enum value to the /// response property for the response status

    • warning

      added the new leverate_crm enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status