The campaign object

Unique identifier of the campaign.

Name of the campaign, between 2 and 99 characters. It must be unique in the account.

IDs of the tags of the campaign. Only the users with at least one of these tags can see the campaign in the Web Console. Send an empty array for no tags.

State of the campaign. New campaigns are created as Draft. Use Change campaign state to activate, pause or cancel a campaign. Campaigns change to Finished automatically.

Only for Active campaigns, and null otherwise: whether the campaign is making calls (Running), or the reason why it isn't.

Priority of the campaign, used to decide from which campaign to take the next numbers to call, when several campaigns share resources.

ID of the phone system used to make the calls.

ID of the extension of the phone system used to make the calls.

Dialer mode of the campaign, and its settings. The mode field defines the mode, and the other fields depend on it.

First day in which the campaign can make calls.

Last day in which the campaign can make calls (this day included), or null for no end date. It can't be earlier than startDate.

ID of the holiday group of the campaign, or null. Holidays use the working times defined for Sundays.

IANA time zone of the campaign, such as America/New_York. Dates and working times are relative to this time zone.

Time ranges in which calls can be made, for each day of the week. Every day must be present: send an empty array for days without calls.

Whether numbers can be added or deleted once the campaign is activated (Dynamic) or not (Static). A static campaign finishes automatically when all its numbers were processed.

Order in which numbers are called: first in, first out (Fifo), or last in, first out (Lifo).

Whether numbers not contacted yet are called before retries (NotContacted), or the other way around (RetryPending).

Prefix added to every number before calling, for example to select an outbound line, or "" for no prefix. Up to 256 comma-separated prefixes can be specified, to rotate between them: each one up to 6 characters, among digits, *, # and +.

Time to wait for the call to be answered: between 1 and 600 seconds, or between 1 and 10 minutes. In Progressive mode, it applies to the call to the agent.

Maximum number of times each number is called, between 1 and 9.

Minimum time between attempts, up to 6 months. Between 1 and 8 intervals can be defined, to use different wait times for successive attempts.

IDs of the black lists with numbers that must not be called. Send an empty array for none.

What happens when a call is answered. The $t field defines the call handling mode, and the other fields depend on it. Required for the Power and Predictive dialer modes, and must be null for the Progressive mode, where the call is always connected to an agent.

ID of the webhook that receives the events of the campaign, or null.

Number of numbers in the campaign.

Number of numbers in each status.

Names of the variables whose values are stored for each number, or null if the campaign has no numbers yet. They are defined by the first numbers added to the campaign.

Whether the campaign is archived. Archived campaigns are hidden by default in the Web Console.

Interactions of the campaign whose results are reported for each call, such as the DTMF inputs of the call flows, or the goals of the AI agent. Used to interpret the inputResults of the call details.

Date and time when the campaign was created.

Date and time of the last change. Send this value as lastUpdatedAt when updating the campaign.

Always null, except in the response of Delete a campaign, where it contains the date and time when the campaign was deleted.

Date and time when the campaign started making calls, or null.

Date and time when the campaign was canceled or finished, or null.