Campaign Manager Console
This document describes the creation and management of campaigns using the Campaign Manager Console.
Console Overview
The user’s drop-down at the top right corner of the console provides an option to view your account details or sign out. Next to it is a link to visit Documentation.
The Campaign Manager console contains four tabs:
Campaigns: Here you can create campaigns and see the details and status of newly created or older campaigns.
Announcements: Here you can create announcements for your voice campaigns and view older announcements.
Number Lists: Here you can create lists of numbers which are required for your campaigns.
Do Not Disturb (DND): Here you can create Do Not Disturb lists and select them optionally during the campaign creation.
Creating a Campaign
To create a campaign, you must have in place the following:
-
An announcement in case of voice campaign
-
Number lists
-
DND in case you are planning to exclude numbers from your campaign
The following sections describe each of the above prerequisites in the order in which a campaign will be created for the first time.Follow these steps to create a voice or SMS campaign.
Create Announcements
| This is not required for SMS campaigns. |
An announcement is the message content for a voice campaign.You can create announcements by uploading a custom audio file or using Text To Speech service after selecting the desired voice variant and gender.
To create an announcement, do the following:
-
In the Announcements tab, click “Create Announcement” button.Create Announcement window appears.
-
Provide a name for the announcement and optionally a description.
-
Select the type of the announcement. This can be either “Audio File” or “Text to Speech”.
-
If you select the “Audio File” radio button, you can do one of the following:
-
Click on the “Record” button and record the announcement through the browser itself or
-
You can drag and drop a wav file into the specified field or click Browse to select the wav file from your local file browser to upload it. The audio file must be 8 khz mono specification with a maximum size of 1 MB and the duration must be a maximum of 3 minutes.
-
-
If you select “Text to Speech” (TTS) radio button, you need to specify the following fields:
-
Select a Language of TTS from the Language drop-down list
-
Select Voice. Options depend upon the TTS providers as below: Google: Male and Female AWS Polly: Male and Female Acapela: Man and Woman Voicerss: Female(only)
-
Enter the text in the Body field that you want to convert to speech.
-
-
Click Save. The announcement is now ready to be used in a campaign. Click Cancel to exit this window without creating an announcement.
The newly created announcement displays the following information:
Name: This column can be sorted in the ascending or descending alphabetical order.
Last Update: This column can be sorted in the ascending or descending order of the last updated date.
Type: This column can be sorted on the type of announcement.
Description
If you have many announcements, the following search filters enable you to easily search for announcements:
-
Start Date: Displays all the announcements created on or after this date.
-
End Date: Displays all the announcements created on or before this date.
-
Announcement name: Displays all the announcements that match the entered name partially or fully.
-
Announcement type: Displays all the announcements that match the selected type. The following options are available to select:
-
All Types
-
Audio File
-
Text To Speech
-
Create Number Lists
You need to create a To List and From List to launch a campaign.
-
To List – The campaign message will be delivered to the numbers in this list.For SMS campaigns it is possible to upload additional columns in the file to personalize message content per target person.
-
From List – The campaign message will be sent from this number.In case multiple numbers are included in this list, they will be evenly used in SMSs/calls.
The steps to create both lists are similar.To create a To List or From List, navigate to the respective list under the Number Lists tab and do the following:
-
Click Add To List or Add From List.
-
Provide a list name and optionally a description. The lists must have unique names for user convenience and to prevent mismatches.
-
Select one of the following radio buttons:
-
Upload File: You can drag and drop a file or click Browse to select a file from your file explorer. The uploaded file will be validated by the Campaign Manager and if the file is proper the status is shown as Ready and if file does not conform to the specification then the file is shown as Invalid.
-
| If the file is Invalid you will not be able to use in a campaign. Refer Numbers File Validation for more information on how to download and correct the file and reupload. |
-
Enter Phone Numbers: This option provides an on-screen option to enter phone numbers. Ensure you enter only one phone number in each line.
-
Click Save.
-
| Once uploaded and validated list content cannot be changed, though it is possible to delete an existing list and upload a new list with the same name. |
Once a list is added, it displays the following information:
-
Name
-
Count
-
Last Updated: This column can be sorted in the ascending or descending order of the last updated date.
-
Description
-
Status:
Ready – list was validated properly and is ready for use
Invalid – list failed validation criteria and cannot be used, as is. User should download results file to review and fix validation errors. Once fixed, the file can be uploaded again, iteratively, till fully validated
When you have many lists, use the following search filters:
-
Start Date: Enter a date to display all the lists created on or after this date.
-
End Date: Enter a date to display all list created on or before this date
-
List name: Enter a To List name or From List name to search for lists matching the entered name.
Message Template
Campaign Manager allows you to send a customized SMS message to each phone number.For this type of SMS campaign, ensure you add a CSV file in the To Number List.This CSV file must contain variables required to construct your campaign message.For example, if your message is “Hi Tom, reward points of 3456 has been added to your ShopXYZ account linked to your phone number 78786887878. Shop before your reward points expire.”
In the above example, all the items in italics are variables.Create a CSV file as shown below with the variables namely Number, Name, and Reward Points:
Numbers File Validation
Uploaded files are verified as follows:
File type
- For To Lists: only csv, txt, and zip files are allowed (zip must include csv or txt file). csv files need to be used for Message Template SMS campaigns.
- For From Lists: only txt and zip files are allowed (zip must include txt file).
File size – file can have up to 1M entries (i.e., rows).Uploaded file (zip, txt or csv) size allowed up to 10MB.If zip file is used, internal file (txt or csv) not limited in size, though, subject to zip file size up to 10MB.
File content – file must contain consecutive entries, blank or duplicate entries are invalid
- txt file – must consist only numeric entries, single column, up to 15 digits per entry, + prefix is allowed.
- csv file – must include top row of variable titles. ‘numbers’ column is mandatory. ‘numbers’ column should consist only of numeric entries up to 15 digits per entry, and + prefix is allowed.Other columns are checked only for blank entries.
In case the file content doesn’t meet the above criteria, Campaign Manager will flag the file as invalid and will allow user to download the results file.When you click on a list that is Invalid the List details window appears as shown in the example below:
Click on the download icon to download the results file and view the errors.An example is shown below.
Once fixed, you can reload the file, till valid upload is accomplished.
Managing Number Lists
Click on a list in the Number Lists tab.The List details appears in a pop-up window.
Edit List: Edit the Name and Description of the list and click Save. Download List: Click on the download icon to download the list. Preview List: Click on the eye icon to preview the list. Delete List: Click on Delete to delete the list.
Do Not Disturb (DND)
You need to create DND Opt-Out and Opt-In lists if you want to use them in a campaign.
-
Opt-Out List: Numbers present in this list will not receive the campaign.
-
Opt-in List: Numbers present in this list will receive SMS/Calls even if included in Campaign’s Opt-Out list (provided obviously, they’re included in Campaign’s To Numbers list).
Below diagram illustrates the relationship between To Number list and Opt Out / Opt In lists in processing and actual delivery of messages/calls.
The steps to create both lists are similar.To create Opt-Out or Opt-In List, do the following:
-
Click Opt-Out or Opt-In in the DND tab.
-
Click Add Opt-Out List or Add Opt-In List respectively. A pop-window appears. Add Opt-Out List window is shown below:
-
Enter a list name and optionally a description. Ensure the lists have unique names for user convenience and to prevent mismatches.
-
Select one of the following radio buttons:
-
Upload File: You can drag and drop a .txt or a .zip file. Ensure the file contains only one phone number in each line.
-
Enter Phone Numbers: This option provides an on-screen option to enter phone numbers. Ensure you enter only one phone number in each line.
-
-
Click Save.
In case the file content doesn’t meet the above criteria, Campaign Manager will flag the file as invalid and will allow user to download the results file (an example is shown below).
Click on the download icon and you can view the errors.Once fixed, user can reload the file, till valid upload is accomplished.
| Once uploaded, and validated, list content cannot be changed, though it’s possible to delete an existing list and upload a new list with same name. |
DND File Validation
Uploaded files are verified as follows:
File type – only txt and zip files are allowed (zip must include txt file) File size – file can have up to 1M entries (i.e., rows). Uploaded file (zip, txt or csv) size allowed up to 10MB. If zip file is used, internal file (txt or csv) not limited in size, though, subject to zip file size up to 10MB. File content – file must contain consecutive entries; blank or duplicate entries are invalid. The file should consist only numeric entries, single column, up to 15 digits per entry, + prefix is allowed.
Managing DND Lists
To search for DND lists in the DND tab, select Opt-Out Lists or Opt-In Lists to view the respective lists. You can use the following search filters:
Start Date: Enter a date to display all the lists created on or after this date. End Date: Enter a date to display all list created on or before this date List name: Enter an Opt-Out List name or Opt-In List name to search for lists matching the entered name.
Click on a list in the DND tab. The List details appears in a pop-up window.
-
Edit List: Edit the Name and Description of the list and click Save.
-
Download List: Click on the download icon to download the list.
-
Preview List: Click on the eye icon to preview the list.
-
Delete List: Click on Delete to delete the list.
Build Your Campaign
Once you are ready with all the prerequisites mentioned in the above sections, you can now start building a campaign. To build a campaign, do the following:
-
In the Campaign tab, click Create Campaign.
-
Campaign Name: Enter a campaign name.
-
From Number List: Select From Number list to be used in this Campaign. Refer Create Number Lists.
-
To Number List: Select To Number list to be used in this Campaign. Refer Create Number Lists.
-
Campaign Type: Select SMS or Voice. SMS: If you select SMS, you need to enter the campaign message in the text field provided.
| For SMS campaigns, Campaign Manager enables you to create customized message to each phone number. To create such messages, you must provide a proper csv file that contains variables at the “To Number List”. When such a csv file is selected in the To Number List, a drop-down list appears with the variables that is defined in the csv file to help you customize the SMS campaign. For more information on creating a csv file with variables, refer Message Template. |
Your campaign message could be like: “Hi ${name}, reward points of ${points} has been added to your ShopXYZ account linked to your phone number ${number}. Shop before your reward points expire.” Each variable that you select from the drop-down while typing your campaign message appears as ${variable}.
Voice: There are 3 ways to set up a voice campaign as described below:
Announcement: This is the simplest way where you need to select a predefined announcement from the Choose Announcement drop-down list. Once Campaign is in progress, the receiver of the call will hear this announcement. Refer Create Announcement. Application: Allows selection of Visual Designer application. This option is intended to support a more sophisticated call flow where you want to collect the DTMF from the end user or want to get a call connected to 3rd party. RCML URL: Allows using your own hosted RCML application. Enter the URL link to the RCML application. You need to select GET or POST according to the preferred API method. Refer RCML Documentation for more details.
-
Select one of the radio buttons and accordingly select the announcement or application from the drop-down list.
-
Dial Timeout. This indicates the number of seconds that Campaign Manager should allow the phone to ring before assuming there is no answer. The default is 30 seconds.
-
DND: Optionally, you can select the DND check box to select predefined Opt-Out and Opt-In lists. Refer Do Not Disturb (DND).
-
| Opt-In file can be added only if Opt-Out file was chosen. |
-
Date and Time: Select either
-
Immediate: The campaign will be launched immediately after the campaign creation is successful.
-
Scheduled Date: Select a future date and time to launch the campaign
-
-
Click Preview. A confirmation pop-up window appears with all the entered details of the campaign.
On this step you can verify all campaign details, preview of SMS template with completed variables and get Estimated Volume of the campaign.
-
Click Confirm after verifying the campaign details. The campaign creation is now complete. The new campaign appears in the Campaign tab. Note: At any time during the campaign creation, you can click Cancel before clicking Confirm to cancel the campaign creation. Once you successfully create a campaign, the following information is displayed:
Name: This column can be sorted in the ascending or descending alphabetical order.
Scheduled Date: This column can be sorted in the ascending or descending order of the created date.
Channel: This column can be sorted by the type of campaign: SMS/voice.
Status: This column can be sorted by the campaign status.
When you have many campaigns, you can easily search for campaigns using the following search filters:
-
Start Date: Displays all campaigns that were created on or after this date.
-
End Date: Displays all campaigns that were created on or before this date.
-
Campaign Name: Displays all the campaigns that match the entered campaign name fully or partially.
-
Campaign Sid: Displays the campaign that matches the entered campaign Sid value.
-
Status: Displays all the campaigns that match the selected status. The following statuses are available:
All status
Initiating: System is processing the Campaign for launch
Scheduled: Campaign has initiated and now pending its schedule to launch
In Progress: Campaign is in progress, sending SMSs or calling the To Numbers
Completed: Campaign has completed successfully
Failed: Campaign was disrupted either due to internal system error or if your Restcomm account was deleted by your Communications Provider while the campaign was In Progress.
Canceled: Campaign was canceled -
Channel: Displays the campaigns that match the selected channel. The following options are available:
All Channel
SMS
Voice
Cancelling a Campaign
The Campaign Manager application allows you to cancel a campaign before the scheduled date and time of the campaign. To cancel a campaign,
-
Click on a campaign. A pop-up window with the campaign details appears.
-
Click on the Cancel Campaign button in order to cancel the campaign.
Volume
You can see current volume of your Enterprise on the top panel
The Volume button in the user’s drop down menu allows you to observe all Volume Transactions of the Enterprise.
Volume transactions can be filtered based on the following:
-
Start Date: Displays all Volume transactions that took place on or after this date.
-
End Date: Displays all Volume transactions that took place on or before this date.
-
Transaction Sid: Displays the Volume transaction that is associated with the entered transaction Sid value.
-
Type: Displays all Volume transactions based on the type of transaction. The following options are available:
-
All Types: Displays all volume transactions
-
Reduction: Displays transactions involving volume reductions.
-
Addition: Displays transactions involving volume additions
-
Campaign Report
To download report once the campaign finished ( canceled or completed) , click on a campaign. A pop-up window displays an additional button of download report.
