Campaign Manager Console

Overview

CPaaS Campaign Manager allows you to send the same SMS and Voice Calls to hundreds of thousands of phone numbers within minutes. For more details, please review the General Documentation.

This document contains important information regarding the setup and management of campaigns using the Campaign Manager UI Console.

To learn more about the API, click here.

Campaign

Once logged into the Campaign Manager console, you can click on Campaign on the top menu to go to the Campaign section to:

  • View a list of all scheduled campaigns

  • Search specific scheduled campaigns by name

Create Campaign

To create a new campaign click on the Create Campaign button.

Upload to Phone Numbers

Campaign Name: Enter the campaign name for later reference

To numbers: Provide the phone numbers to which you want to initiate the Campaign. You can either upload a .csv or .txt file with each number in a different line or manually enter the phone numbers, again one number per line. When you are done, click Next.

create campaign main screen
When uploading a file of To Numbers, make sure to have one number per line as shown in the image below.
upload to phone numbers

Upload From Phone Numbers

Provide the phone numbers from which the SMS will be sent in the “Upload From Phonenumbers” section. You can upload a .txt file from Phone Numbers, enter phone numbers manually, or generate From Phone Numbers randomly. When you are finished, click Next.

In the Generate From Numbers option, you will need to select a country code. The campaign manager will then generate a random source/from address that corresponds to the selected country code to send the SMS.
upload from phone numbers

Content

You can select the content type as either SMS or Voice. Based on your selection the screen will refresh and provide a corresponding option.

SMS

Choose the correct type of message encoding, then type your message in the text field provided. When you are finished, click Next.

The types of encoding available are:

  • GSM7: Supports standard alphabets.

  • UCS2: Supports almost all traditional characters like Simplified Chinese, etc.

content-sms
Encoding will affect the message length. If the message length is more than 160 characters for GSM7 and 70 characters for UCS2, it will become a multi-part message consuming more than 1 credit.
Voice

There are 3 ways to setup Voice campaign as explained below

  • Announcement: This is the most simple way where you need to first define an Announcement as explained in Section 4 Announcement. Once Campaign is in progress, the receiver of the call will hear the Announcement.

  • Application: This is if you are looking for 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 for example contact center agent based on input received from users. You need to first define an Application as explained in Section 3 Applications

  • RCML URL: This is for most advanced users who have hosted their own Applications which would return the RCML as explained here RCML Documentation

DialTimeout: The number of seconds that Campaign Manager should allow the phone to ring before assuming there is no answer. The default is 30 seconds.

Do Not Disturb (DND)

Provide the Opt-Out and Opt-in Database name. When you are finished, click Next.

Opt-Out: Name of the list of numbers in the Opt-out. The only accepted value is Opt-Out.
Opt-In: Name of the list of numbers in the Opt-in.

The Opt-Out and Out-In name should match the Name that you have created. Otherwise it will be ignored.
DND Opts

Schedule the Campaign

Select the date and time at which you would like to send the SMS to the intended recipients. Or leave the “Schedule Date” field empty to let the campaign be scheduled immediately. Click next to get a preview of Campaign and have final confirmation.

schedule campaign screen

Edit Campaign

The Campaign Manager application allows you to edit the status of the campaign before the scheduled date and time of the campaign. On the Campaigns list, click on the name of the campaign.

  • The status of the campaign can be changed from Scheduled to Cancelled.

edit campaign

Delete Campaign

A scheduled campaign can be deleted. To delete a campaign click on the name of the campaign and click the Delete button. Once deleted, the status of the campaign will be marked Cancelled.

Applications

You can create a Visual Designer Application here. Check out the Visual Designer Documentation to learn more about how you can do that. Users can view a list of Applications.

Visual Designer allows you to define call flow via low-code, no-code, drag and drop tool where you can collect DTMF input from the end user or connect the call to 3rd party like contact center agents and much more.

Announcement

To navigate to this page click on Announcements on the top header. Announcements allow you to upload audio file (.wav 8Khz only), record your own announcement or write text-to-speech that would be played when a call is established.

Users can view a list of all announcements that have been added under the enterprise.

create-announcement

Click on “Create Announcement” button

  1. Enter the name of the announcement.

  2. Enter description of the announcement.

  3. Announcement can be via “Text to Speech” or “Audio File”

  4. For “Audio File”, user can upload a announcement by:

    • Click on the “Record” button and record the announcement through the browser itself.

    • Drop the wav file with 8 khz mono specification from the local files into the specified field.

    • Click on “Browse” and select the audio file of announcement from the local files (wav file with 8khz mono specification)

  5. For “Text to Speech” (TTS), user can

    • Specify Language of TTS

    • Specify Voice. Options depend upon the TTS providers and are as below:

      1. Google: Male and Female

      2. AWS Polly: Male and Female

      3. Acapela: Man and Woman

      4. Voicerss: Female(only)

    • Specify TTS body/text.

Do Not Disturb (DND)

You can define two types of database (or list of numbers):

  • Opt-Out

  • Opt-in

Opt Out

The numbers present in this list are used for DND. A maximum of one Opt-Out database can be created.

Search Opt-Out

You can search the Opt-Out numbers created using the following filter options:

  • Start Date: Display opt-out value created on or after this date.

  • End Date: Display opt-out value created on or before this date.

  • Number: Display opt-out value that partially or fully matches the entered value.

search-opt-out

Create Opt-Out

You can either upload a .csv or .txt file where each number is on a separate line, or you can manually enter the phone numbers (one number per line). When you are done, click Confirm.

add-opt-out

Opt-In

Numbers present in this list are used for receiving SMS/Calls for a specific Campaign only.

Search Opt-In

You can search the Opt-In Numbers created using the following filter options:

  • Start Date: Display opt-in value created on or after this date.

  • End Date: Display opt-in value created on or before this date.

  • Number: Display opt-in value that partially or fully matches the entered value.

  • Opt-in name: Display opt-in value that partially or fully matches the entered opt-in name.

search-opt-in

Create Opt-in

Name: Enter the name of the Opt-in database Numbers: You can either upload a .csv or .txt file where each number is on a different line, or manually enter the phone numbers (one number per line). When you are done, click Confirm.

add-opt-in

Search

You can search SMS, Voice, Campaigns and Credits based on a different filter parameters.

Search SMS

Search Campaign

You can search all the campaigns created using the following filter options:

  • Start Date: Display campaigns created on or after this date.

  • End Date: Display campaigns created on or before this date.

  • Campaign Name: Display campaigns the partially or fully match the entered value.

  • Status: Display campaigns with the Status selected from the dropdown. The values available are Initiating, Scheduled, In Progress, Completed, Failed, Cancelled, and All Status. The default value is All Status.

  • Channel: Display campaigns based on channel selection.

search-campaign

Campaign Details

You can view the details of a particular campaign by clicking on the name of that campaign.

campaign-details

Search Credit

You can search all the credits added by CPaaS to your business. Credits help you to create campaigns and send SMS/Voice to your own customers or audience. This model is pre-paid to make sure that cost will never overrun the budget you have available.

Possible filter options include:

  • Start Date: Display credits created on or after this date.

  • End Date: Display credits created on or before this date.

  • Type: Display credits with the selected type. The possible values of type are Credit, Debit, and All Types.

search-credit

  • Whenever Campaign is scheduled, equivalent Credit is deducted.

  • If there is not enough Credit available, scheduling of Campaign will fail.

  • If Scheduled Campaign is cancelled, equivalent Credit is added back.

  • Once a Campaign progresses to InProgress state, Credit cannot be reversed, no matter what.

  • One credit is equal to 1 SMS or 1 Voice call.

  • For example,if you have 100 credits, you can only send 100 SMS Segments or 100 Voice calls.

Credit Details

You can view the details of a particular credit by clicking on the SID of that credit.

search-credit