Table of Contents
Status colour Yellow title This wiki has been updated for Version 13 of your PBX GUI
Table of Contents
The Broadcast (XactDialer) module allows you to send broadcast a message broadcasting to a predefined list of phone numbers. You can decide which message is played depending on if a human answers the call or an to use different messages or destinations based upon whether a person or answering machine/voicemail answers the call.A campaign is a
- Campaign: A set of instructions on
- when to dial, which call group(s) to dial, and where to route the call. Also known as a Broadcast Campaign.
- Call Group: A list of names and numbers
- . A campaign can contain one or more call groups.
Log into the “Broadcast Module” and you will see this screen.
To navigate to the Broadcast module:
- In the top menu, go to Applications
- In the drop-down, choose Broadcast
You will see a screen like this, landing on the Groups tab:
In this wiki, we'll go over the tabs from left to right, starting with Status.
Click the Status tab. This page works like an on/off switch for the broadcast service as a whole, and shows whether the service is running. It also shows which campaigns are active, whether they have been started, how many calls have been placed, and how many calls still need to be placed. You can download a report for the campaign.
When the broadcast service is running, calls will be placed for any active campaigns.
Number of Concurrent Calls- Max number of calls all running campaigns can place at anytime.
- Here you can view all active campaigns and toggle which campaigns are active.
- See how many calls have been placed and how many still need to be called.
- Reports allow you to download a CSV of all calls included in the campaign and the call status.
On the right side we can see a list of all campaigns that have been created. Click on “Add a Campaign” to create a new one or click on any campaign to edit the campaign settings.
Campaign Name- A unique name for this campaign.
- Campaign Caller ID- What caller ID you want set for any calls from this campaign.
- Dial Prefix- If you need to set a prefix (such as 9) before dialing the numbers, set it here.
- Email Reports To- What email address to send reports on this campaign to.
- Email Reports- When to send email reports on this campaign.
- Campaign Active- If active calls will be placed from this campaign when you start the dialer.
Here you define which call groups should be dialed. A “call group” is a list of names and numbers that will be dialed.
- You can pick one or more call groups to be included with this campaign.
Call List Groups
- URL Source- The FTP or URL link to your file. Format would be "ftp://username:firstname.lastname@example.org/mylist.csv"
- Delete after Retrieving-After pulling down the list should we delete the file from the FTP directory? If the server is unable to delete the file, the import is not processed. This option is ignored when using HTTP to retrieve files.
- Update Period- How often should we look for a new file and pull it down in seconds
In our example above we are looking for a csv list called mylist.csv from our FTP server every 5 minutes and if we find the file we pull it down and delete it from the FTP server.
Toggle Campaign on or off remotely
Now route a inbound DID to the IVR and you have full control to activate or deactivate your campaign.
If you have the Dialer service stopped and you activate the Campaign through the toggle switches it will start the dialer service for you automatically.
When the service is stopped, no calls will be placed.
|The broadcast service does not stop automatically after completing a campaign. It will keep running and checking for newly active campaigns, or added numbers to call. This is a significant change from previous usage, and it's important you are aware of this.|
The Start/Stop button starts or stops the broadcast. Click the button to toggle the status. Changes take effect immediately. The status will be updated above the button to say "Stopped" or "Running" depending on the current status.
This section shows campaigns that have not yet completed. The Active checkbox indicates whether a campaign is active. However, remember that the broadcast service also needs to be running (see service status, above) in order for calls to be placed.
You can check / un-check the box to activate/deactivate a campaign.
Click the Report button to download a CSV file containing a report for the campaign.
|10/23/15 16:09||3||Tango Frog||5555551212||yes||yes||person|
Click the Complete button if you would like to manually mark a campaign as complete.
This section shows campaigns that have been completed.
Click the Report button to download a CSV file containing a report for the campaign.
Click the Restart button to move a completed campaign back to the Current Campaigns section.
Click the Delete button to delete a completed campaign.
Click the Groups tab.
From here, you can add, edit, or delete lists of names and numbers. You can include one or more call group within a single broadcast campaign. Any existing groups will be shown.
- To Add: Click the Add Group button.
- To Edit: Click the pencil button next to an existing group.
- To Delete: Click the trash button next to an existing group. Then click OK to confirm the deletion.
You'll be taken to the Group Options tab when you add or edit a group.
The Call Group Name field is mandatory. Others are optional, as you are not required to use a CSV file. You will have the option to enter names and numbers manually after submitting the data in this tab.
Call Group Name
The name of this call group.
Call Group URI Source
A URI to import the call group from. This currently supports FTP and HTTP in CSV format. FTP format would be "ftp://username:email@example.com/mylist.csv"
Delete after Retrieving
(FTP ONLY.) Yes/No: Whether to attempt to delete the file after downloading it from the URI provided above. If the system is unable to delete the file for whatever reason, then the import will not proceed.
The time, in seconds, between URI updates.
Update From CSV
You can import a CSV file formatted as follows:
Names should be enclosed by '"' and fields separated by ',' Example:
The command is either 'add' or 'remove', is optional, and defaults to 'add'. Examples:
Click the Browse button to upload a CSV file. Choose the CSV file from your computer.
Click the Submit button when done.
Numbers to Call
Click the Numbers to Call tab. (Note: This tab is only visible after you have submitted information in the Group Options tab).
- To add a new callee: Enter the name and number in the blank fields, and click the Add/Edit Callee button.
- To edit an existing callee: Click the Edit link for the entry, edit the name/number, and click the Add/Edit Callee button.
- To delete an existing callee: Click the Delete link for the entry, and click OK in the pop-up window to confirm deletion.
The name of the callee.
The phone number of the callee.
Click the Add/Edit Callee button to save changes.
Click the Campaigns tab. From here, you can add, edit, or delete broadcast campaigns. You can activate/deactivate a campaign when adding or editing it. Any existing campaigns will be shown in a list.
- To Add: Click the Add Campaign button.
- To Edit: Click the pencil button next to an existing campaign.
- To Delete: Click the trash button next to an existing campaign. Then click OK to confirm the deletion.
(Optional; Visible when you are creating a new campaign.) You can choose to duplicate an existing campaign. Select the campaign you wish to duplicate, then skip to clicking Submit. This allows you to run the same campaign after it is completed while keeping previous campaign reports intact.
A unique name for this campaign.
Maximum number of concurrent calls this campaign can make.
Campaign Caller ID
The caller ID that outbound calls will use for this campaign.
(Optional) A prefix to be appended to every number before it is dialed. This is useful, for example, to force calls to go out through a specific outbound route.
Email Reports to
The email address you wish the report to be emailed to.
Never / Daily After End Time / After Campaign Completes: When to e-mail a report.
- Never: A report is not sent.
- Daily After End Time: A report is sent each day after the end time is reached, and also after the campaign is completed.
- After Campaign Completes: A report is sent after the campaign completes.
Yes/No: Whether the campaign will be active after submitting the data on this page. Select Yes to activate the campaign upon addition/modification.
The broadcast service must be running in order for the campaign to begin, even if you select Yes here. You will need to visit the Status tab if you haven't yet started the broadcast service.
To specify which call group(s) will be included in this campaign, drag one or more call groups out of the Not Included bin and drop in the Included bin.
Date and time options for this campaign.
Destination - Live Person Answered
Where to send calls answered by a live person.
Destination - Answering Machine / Voicemail Answered
Where to send calls answered by an answering machine or voicemail. Please note, the system makes all attempts to detect a voicemail or answering machine, but this is not guaranteed to be reliable. Answering Machine Detection (AMD) is handled by Asterisk, and must be configured independently. The default settings for AMD may work, but may need to be adjusted for your specific system and trunks. You can manually review and edit Asterisk AMD settings in the file amd.conf using the Config Edit module. When selecting destinations for answered calls, please ensure you plan for the occasional possibility that calls may be falsely flagged as either machine or human.
Click the Submit button, then click the Apply Config button. (Remember, the broadcast service must be running in order for this campaign to begin. Please visit the Status tab to check status.)
Click on the General Settings tab.
The maximum number of calls ALL running campaigns (combined) can place at any given time. This should be less than the total number of channels available on the system, in order to still allow other calls to be made and received while a broadcast campaign is in progress.
The maximum number of times to try calling busy numbers back.
Report 'From' Address
(Optional) If you would like to customize the "from" e-mail address that reports appear to come from, enter the e-mail address here.
How to Toggle a Campaign On or Off Remotely
If you point a destination of your PBX to a start and stop toggle for a campaign, you can activate/deactivate the campaign at any time simply by dialing the destination.
If the broadcast service is stopped, it will begin running automatically if you activate a campaign through dialing a toggle.
For example, if you have a campaign set up (but not active) to alert parents that school is closed for the day due to weather, you could create a hidden IVR with an option to press 134 to activate the "School Closed" campaign, and 234 to deactivate it. Dialing 134 from the IVR would be the same as checking the Active box in the Status tab of the Broadcast Campaigns GUI page. You could route an inbound DID to the IVR to allow someone to access it remotely.
Example IVR entries: