Campaigns

Create campaign

Changed on Nov 3, 2026

Creates a new outbound dialer campaign.

post/api/v4/campaigns

Request

Base URL
https://{cluster_id}.voiso.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/voiso/apis/voiso-api/docs/api/v4/campaigns/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

The name of the campaign. Must be unique within the contact center.

strategy'simple' | 'predictive_ai'

Dialing strategy for the campaign. predictive_ai is only available if Dialer AI is enabled for the contact center.

dial_levelnumber float

Number of simultaneous call attempts per available agent.

max_dial_timeinteger

Maximum time in seconds to spend dialing a contact before hanging up.

max_wait_timeinteger

Maximum time in seconds to wait for an available agent when a contact answers.

max_dial_attemptsinteger

Maximum number of attempts to dial a contact.

voice_message_idinteger nullable

Identifier of the voice message to play. Must reference an existing voice message in the contact center.

amd_enabledboolean

Whether answering machine detection is enabled for calls.

amd_comfort_noise_enabledboolean

Whether comfort noise plays in the background while answering machine detection analyzes the answered call. When disabled, the audio the campaign plays while the contact waits for an agent starts as soon as the contact answers. Requires answering machine detection to be enabled.

use_local_caller_idboolean

Whether to use only caller IDs matching the contact's country or region.

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

Example request

{
  "name": "Summer Outreach Campaign",
  "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_id": 42,
  "amd_voicemail_message": {
    "voice_message_id": 43
  },
  "amd_enabled": true,
  "amd_comfort_noise_enabled": true,
  "live": {
    "enabled": true,
    "dialing_order": "fifo"
  },
  "caller_id_sets": [
    {
      "phone_numbers": [
        "18885650001",
        "18885650002"
      ]
    }
  ],
  "asr_optimization_enabled": true,
  "post_call_rating": {
    "enabled": true,
    "notification_voice_message_id": 1,
    "instructions_voice_message_id": 2,
    "complete_voice_message_id": 3
  },
  "contact_local_time": {
    "start_time": "07:30",
    "end_time": "22:00",
    "days_of_week": [
      1,
      2,
      3,
      4,
      5,
      6,
      7
    ]
  },
  "follow_up_mode": "timer",
  "follow_up_rules": {
    "machine_answered": [
      {
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ],
    "abandoned": [
      {
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ],
    "no_answer": [
      {
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ],
    "rejected": [
      {
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ],
    "failed": [
      {
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ],
    "busy": [
      {
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ],
    "wrapup_code": [
      {
        "wrapup_code_id": 12,
        "wait_time": 300,
        "wait_time_unit": "seconds"
      }
    ]
  }
}

Response

Created

Example response

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

Changes

Nov 3, 20265a6ea146bd21 Revision changes
- 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 new optional request property
- info
  added the new optional request property /
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status

Operation history