Creating a campaign
To create a campaign, navigate to “Campaigns” in the sidenav, and click “Create campaign” in the top right.
- Name: Name of your campaign
- Description (optional): Description of your campaign.
- Labels (optional): Add labels or tags.
- Channel source: Select a channel source, which is assigned to an outbound agent, that will be doing the outreach
- Display ID: Enter the phone number or caller ID that your recipients will see
- Rate per hour: Set the rate of outreach per hour (e.g., If set to 60, it will try to do 1 outreach per minute)
- Campaign hours: Set the days and hours of operation for your campaign. You can set it so that it will only run during weekdays, or normal business hours of 9 to 5.
Creating a batch
A batch is a grouping of phone numbers to call. Phone numbers to call are populated in a batch by uploading a CSV or manually adding a phone number. To create a batch, click on a campaign, click the “Batches” tab and “Create batch” when you are viewing a campaign.
- Expires on (optional): Can set an expiration date for the campaign to end. This may or may not occur after all the contacts are reached out to.
- Note: Phone numbers in the batch will not be called after the expiry time
- Auto-run batch: This toggle is to immediately start running the campaign on the batch.
- If enabled, the campaign will automatically start reaching out to the contact list when you click “Save”. And new phone numbers added to the batch will be automatically called.
- If disabled, the campaign will be paused when you click “Save”, and you will need to click “Start” to have it begin reaching out.
Uploading a batch
You can create a batch in a few ways:- Directly through the API endpoint
- Upload a CSV file in the UI
- reference_id: A unique identifier
- target: Phone number in format +14155551234
- Any other columns can be referenced in the agent prompt or message. For example, if the CSV has a column “first-name”, the agent message can be configured to say something like “Hello vars.first-name” when that phone number is called.
Batches
A campaign can have multiple batches. But a batch can only have one file upload.
- Active: When batch upload is successful and campaign is running (e.g., Auto-run is enabled)
- Paused: When batch upload is successful and campaign is paused (e.g., Auto-run is disabled)
- Pending: When batch is created, but there is no file uploaded yet or is being processed
- Failed: When batch upload is unsuccessful
- Canceled: When batch is canceled
- Expired: When batch is expired
Testing your campaign
To test your campaign configuration and batch file upload, you can try sending one test call to see if it follows the specified business hours and rate of outreach.- Go to a campaign, click on Batches tab
- Click on a batch and add a test number to the “Add to queue” section
- By clicking “Add”, it will be added to the batch, and will follow the campaign settings for business hours and rate of outreach.
- Note: Depending on your campaign settings, you may need to wait until the next scheduled outreach.
