Skip to main content
A campaign is how you dial a large list of contacts in one coordinated operation. Instead of triggering individual calls one at a time, you upload your contact list, assign a script, and Scalysis handles the scheduling and dialing automatically. Campaigns are the right tool whenever you need to reach more than a handful of people — whether you are confirming cash-on-delivery orders, running a re-engagement list, or handling failed delivery follow-ups.

​
Campaign Lifecycle

Campaigns move through a defined set of states from creation to completion. Understanding this lifecycle helps you know when to start, pause, or inspect a campaign. Campaigns are created in the not_started state by default. Use the startImmediately flag (see below) to move directly to running on creation, or start the campaign manually via the API or dashboard later.

​
Campaign Kinds

Scalysis supports three campaign kinds, each optimised for a different merchant workflow:

cod

Cash-on-Delivery — Confirm COD orders with customers before dispatch to reduce return rates.

list

List — General-purpose outbound dialing for any contact list, such as re-engagement or surveys.

ndr

NDR (Non-Delivery Report) — A specialised flow for following up on failed delivery attempts.
Set the kind field when creating a campaign to select the appropriate flow.

​
Uploading Contacts

You can supply contacts to a campaign in two ways: Pass contacts as a JSON array of objects. Each object should include the fields your script expects (at minimum a phone number):

​
csvText String

If you have a CSV export from your order management system, pass the raw CSV content as a string in the csvText field:
Prefer the contacts[] array for programmatic integrations — it is easier to validate and debug than a raw CSV string. Use csvText when you already have a CSV export and want to forward it directly without parsing.
The maximum number of contacts per create request is approximately 2,000. If your list is larger, split it across multiple campaign creation calls.

​
Key Campaign Options

​
startImmediately

Controls whether dialing begins as soon as the campaign is created.
  • true — the campaign moves to running immediately after creation.
  • false (default) — the campaign is created in not_started state; you start it manually.

​
maxConcurrency

Sets the maximum number of simultaneous outbound calls Scalysis will place for this campaign. This is useful for rate-limiting your outreach or staying within carrier thresholds.
The server may enforce an upper cap on maxConcurrency regardless of the value you provide. Contact Scalysis support if you need a higher concurrency limit for your account.

​
Creating a Campaign

Send a POST request to /api/v1/campaigns with your contact list, script, and options. A successful response returns the campaign_id you will use for all subsequent control operations.
Response:
Save the campaign_id immediately. You will need it to start, pause, resume, or stop the campaign through subsequent API calls.

​
Controlling a Campaign

Once a campaign is created, use POST /api/v1/campaigns/{campaign_id}/control to change its state. Pass an action field in the request body:
Response:
Use pause and resume to temporarily hold dialing during peak hours or when you need to update your contact list. Use stop only when you want to permanently end the campaign — a stopped campaign cannot be restarted.