Skip to main content

Dialer campaigns

A campaign is a list of people to call. The PBX places the calls through your dial plan, follows the hours you set, keeps inside the simultaneous calls of your licence, and shows you how it is going while it runs. Find it under Admin, Contact centre, Dialer campaigns (/admin/campaigns): the Campaigns page lists voice and message campaigns together as cards, each with its state (draft, scheduled, running, paused, stopped or completed), its progress and the same buttons (start, pause, resume, stop after a confirmation). You need queues:read to look and queues:write to change.

There are two kinds:

  • Blaster (broadcast). Plays one message to everybody who answers, many calls at once, with an optional key menu. Use it for reminders, notices and outages.
  • Power, predictive and preview. Call lists for the agents of a queue (see also Queues and ring groups). Power places up to the campaign's lines per idle agent; when a person answers, they are connected to the free agent who has been idle longest. Predictive starts with one line per idle agent and only dials ahead once 30 calls have been answered, from the measured answer rate and never past the abandon-rate limit. Preview dials nothing by itself: each agent reads the next contact first and decides (see Preview campaigns). If no agent frees up within 2 seconds of a person being recognised, they hear a short spoken apology (in the language of the campaign, or two tones if nothing can be spoken) and the call ends; it counts as abandoned against the abandon-rate limit, and the dialer places fewer calls ahead as that limit nears (never above the legal 3 %). An answering machine is hung up on unless the campaign sends machines to an agent.

Create a campaign​

  1. Open Campaigns and choose New voice campaign. The form has sections. In Basics give a name, the Mode, the queue (for a blaster, the queue whose agents take the people who press the agent key) and the extension that places the calls. Every call goes through the dial plan as that extension, so its calling profile, outbound rules and caller IDs decide whether and as whom each call goes out.
  2. In Audience tick one or more audiences: everybody in them with a phone number becomes a contact, except numbers on the opt-out list. Later, Add new people from the audiences on the campaign's page adds the people who joined them since.
  3. Set Schedule and windows, Pacing and channels, the Message (blaster only) and Compliance and opt-out (below), then Create campaign. A running campaign cannot be edited: pause it first.
  4. Add more contacts by hand if you like: one per line, the number in international format, then optionally a comma and a name, and a comma and the contact's own time zone (for example +525512345678, Ana, America/Cancun). A number already in the campaign is skipped. Up to 1000 per request. Import contacts from a file takes a CSV or text file in the same format (a header line and # comments are skipped; any size, sent in parts). A contact that is still waiting to be dialled can be corrected with Edit in its row (number and name; its other data is kept).

Scheduling​

SettingWhat it does
Campaign time zoneThe zone the start, the end and the calling hours are read in. Pick it from the same list as the company time zone.
Start and EndOptional. A scheduled campaign starts by itself at its start time, even if the server restarted meanwhile. A running campaign whose end time passes completes.
Calling days and hoursEvery day all day, or only the days and hours you switch on, per weekday, in the campaign time zone. Outside them the campaign waits and the live page says when the window opens.
Contact's local hoursA contact is called only between these hours of its own day: 08:00 to 21:00 by default. The contact's own time zone is used when you gave one, otherwise the zones of the country of its number (a number whose zone cannot be told must be inside the hours in every zone of its country). A contact that is outside its hours is not skipped: it waits and is called when its morning comes, and the attempt is not counted.
Legal hoursOn top of your hours, the legal calling hours of the country of every number always apply (see the compliance rules below).

Scheduling needs a Start in the future: set it, save, then press Schedule. Unschedule turns a scheduled campaign back into a draft. The scheduler runs on one server of the installation at a time; if that server stops, another takes over within seconds and nothing is lost, because the state is in the database.

Start, pause, resume and stop​

ButtonFromWhat happens
ScheduleDraftWaits for its start time.
StartDraft or scheduledStarts dialling now (still inside its calling hours).
PauseRunningNo new calls are placed. Calls already in progress finish and are recorded.
ResumePausedDialling continues with the contacts that are left.
StopScheduled, running or pausedEnds the campaign for good. Calls in progress finish. Contacts not yet called stay pending: they are not called and they show as not called in the results. A stopped campaign cannot be started again or edited; add the people you still want to a new campaign.

Stop asks you to confirm because it cannot be undone. Pressing a button twice, or on a campaign that is already there, does nothing and raises no error. A campaign completes by itself when every contact is finished (reached, out of attempts or cancelled), or when its end time passes. Every change of state is recorded in the change history and sent as an event (campaign.scheduled, campaign.started, campaign.paused, campaign.stopped, campaign.completed).

Blaster mode​

Choose Blaster (broadcast) and give the campaign a message:

  • Text read aloud: up to 1000 characters, spoken in the language you give.
  • Recording from the media library: a prompt you uploaded under Prompts.

When a call is answered the PBX listens for a few seconds to tell a person from an answering machine:

  • A person hears the message. If you set keys, the call then waits about eight seconds for one. The opt-out key puts the number on the opt-out list at once (the contact is never called again, by any campaign of the company) and ends the call. The agent key connects the person to the free agent of the queue who has been idle longest: that agent's phones ring and, when they answer, the two talk. The agent counts as busy for the queue until the call ends. If no agent is free or the agent does not answer, the call ends and the result is person with the problem agent_unavailable or agent_no_answer. Any other key, or none, ends the call after the message. A key pressed while the message is still playing counts at once.
  • An answering machine gets the message after the beep when Leave the message on answering machines after the beep is on (the call counts as an answering machine); when it is off, the call just ends and the When a machine answers setting decides whether the contact is tried again.

Results per call are person, answering machine, no answer, busy, failed, opted out and connected to an agent.

Retries​

Attempts per contact and the wait between attempts are the campaign's. Under Retries you can set a different wait, in minutes, after no answer, after busy and after a failed call; an empty field uses the campaign's own wait. The shortest wait is one minute. A person who opted out and a contact who was reached are never tried again.

Channels and the licence​

Campaign calls are ordinary trunk calls: they use the simultaneous calls of your licence, the same pool your people's calls use.

  • Most calls at once cannot be higher than the licence's simultaneous calls. The console tells you the licence figure under the field and refuses a higher value with the limit in the message; the server refuses it too.
  • Calls kept free for regular traffic (2 by default) is a reserve the campaign never touches. While the campaign runs, it uses at most the licence's simultaneous calls minus this reserve in total with regular calls. When your people make and receive more calls, the campaign places fewer; when they hang up, it places more. Regular calls always have priority, and calls already up are never cut.
  • If the licence is lowered, a campaign saved with a higher value is held at the new limit when it runs.
  • A licence without a simultaneous-call limit, or no licence state yet, applies no licence ceiling; Most calls at once still limits the campaign.

The live page tells you what is holding the campaign back: its own limit, the licence, or regular calls using the pool.

Live view​

Open Live view on a campaign. The picture is read once and then kept current by the events connection: the page does not poll while the connection is live (if it drops, the page re-reads every 15 seconds until it is back). It shows:

  • Progress: contacts, calls placed, remaining, and the results (person, answering machine, no answer, busy, failed, opted out, to an agent, abandoned), with a progress bar.
  • Channels: calls in progress against what the campaign may use, with the campaign setting, the licence figure, the reserve and the active calls of the whole installation.
  • Rates: calls per minute, the answer rate and the average call length of the last 15 minutes. For agent campaigns also the lines per agent, the abandon rate and idle and busy agents.
  • A chart of calls per minute over the last half hour, with the answered part marked.
  • Calls in progress: number, name, state (ringing, listening, playing the message, waiting for a key, connecting to an agent), time and attempt.
  • What the campaign is doing now: placing calls, waiting for its calling hours (and when they open), waiting for retries or contacts' local hours, held back by the licence, and the last problem the engine had.

The buttons of the campaign are on the page too, and Export results (CSV) downloads one row per call placed, and one row for every contact never called.

Preview campaigns​

In a preview campaign the agents of the campaign's queue work the list from the Agent page of the console (/agent):

  1. Get next contact shows the next contact that is due, with its name, number and the data of the list (for example the plan or the reference from your CRM). It has already passed the compliance checks below. The contact is held for you for 5 minutes; nobody else gets it meanwhile, and asking again shows the same contact.
  2. Dial rings your own phone first, then calls the contact as you: your dial plan, calling permissions and limits apply, as for any call you place. Skip for now gives the contact back (it is due again 15 minutes later, and the attempt does not count); Do not call removes it from this campaign.
  3. After the call, choose how it went (talked to the person, no answer, busy, voicemail, wrong number, or asked not to be called), an optional wrap-up code and a note, then Save and finish. No answer, busy, voicemail and failed calls are tried again with the campaign's retry rules; "asked not to be called" puts the number on the opt-out list. A dialled contact without a disposition is recorded as answered after 2 hours.

You need permission to place calls (every built-in role has it). The live view and the results export show the preview attempts with their wrap-up code.

Contacts from your CRM​

On a campaign's page, Add from your CRM searches the CRMs you connected under CRM integrations (up to 20 contacts per CRM and search) and adds the contacts that have a phone number, with their CRM reference and company. Search again for more. Audience lists and file imports remain the way to load large lists.

Opt-out list and compliance​

The opt-out list below the campaigns holds the numbers no campaign of the company calls. Add numbers by hand or Import a file: a CSV or text file with one number per line (the first column is read; a header line, blank lines and # comments are skipped). Contacts on it, on the company's AI do-not-call list or on the installation's global list, Mexican numbers on REPEP, and numbers on a loaded national do-not-call registry of their own country are cancelled before they are dialled.

Call consent. Turn on Call only people with a recorded call consent in a campaign's settings to call only the people of its audience lists who opted in to calls: the voice consent of the person (an import column such as consent voice, or the consent you record for the audience). Contacts without it, and contacts added by hand without a person behind them, are cancelled with the reason No consent. The legal calling hours and the abandon-rate limit of agent campaigns are described in the campaigns guide; they are defaults for review, not legal advice, and you remain responsible for the rules that apply to the people you call.

The Campaign compliance page (/admin/campaigns/compliance, queues:read) brings these together:

  • Calling window of a number: enter a number to see its country and time zones, whether a campaign may call it now, and when the window opens next.
  • Abandoned calls and cancelled contacts: for every voice campaign, the abandon rate of the last 30 days against its limit (a gauge, and Slowed down when the pacing is throttled), the calls placed, answered and abandoned, and how many contacts the opt-out list, the installation's opt-out list and REPEP cancelled.
  • Do-not-call registries (system administrators only, system.settings:read to see and system.settings:write to upload): how many numbers REPEP, the installation-wide opt-out list and each national registry (United States, Canada, United Kingdom, Spain, Germany, France, Brazil, Australia, India, Italy) hold and when they were loaded. A national registry is the file you obtain from that country's registry operator under your own subscription; numbers in it without a country code are read as numbers of that country, and a registry only ever blocks numbers of its own country. Uploading a file replaces the registry; a large file is sent in parts for you.