/v1/power_campaign/create/

name

string

Defaults to Time to change rally

Campaign name

phonebook_ids

array of strings

required

ID's of phonebooks to be used in campaign

phonebook_ids*

startingdate

string

Starting date of the Campaign in "YYYY-MM-DD HH:MM:SS" format

expirationdate

string

Expiry date of the Campaign in "YYYY-MM-DD HH:MM:SS" format

daily_start_time

string

Defaults to 08:00

Daily start time in "HH:MM" format

daily_end_time

string

Defaults to 21:00

Daily end time in "HH:MM" format

callerid

string

required

Caller ID to be used in campaign

callerid_block

int64

ID of dynamic Caller ID Block to be used in the campaign

timezone

string

Defaults to America/Denver

Name of campaign timezone. Default value is the accounts timezone.

use_contact_timezone

boolean

Defaults to false

Call people in their timezone. This will be used only for contacts in US.

block_cellphone

boolean

Defaults to True

Block cellphone numbers in phonebook. Set as True if you don't have opt ins.

block_litigators

boolean

Defaults to True

Block litigators in phonebook.

sort_order

string

Defaults to phonebook

Calling order of campaign. Options are "phonebook", "number"

notes_required

boolean

Defaults to True

Force agents to add notes for every call.

record_calls

boolean

Defaults to True

Record all calls for this campaign.

agent_assignment_choice

integer

enum

Defaults to 2

Assign Team 2. All Agents 3. Selected Agents 4. Only Default Agent

Allowed:

monday

boolean

Defaults to True

Campaign is operational on Mondays.

tuesday

boolean

Defaults to True

Campaign is operational on Tuesdays.

wednesday

boolean

Defaults to True

Campaign is operational on Wednesdays.

thursday

boolean

Defaults to True

Campaign is operational on Thursdays.

friday

boolean

Defaults to True

Campaign is operational on Fridays.

saturday

boolean

Defaults to True

Campaign is operational on Saturdays.

sunday

boolean

Defaults to True

Campaign is operational on Sundays.

call_dispositions

array of strings

Call dispositions (case-sensitive) to be available to the agents in this campaign. E.g. ANSWER

call_dispositions

create_missing_dispositions

boolean

Defaults to False

Create missing dispositions

script

array of objects

required

Array of script sections for the static script of the campaign. Sequence of script sections is preserved.

script*

template_id

integer

Custom script with label and questions. Use this OR template_id, not both.

agents

array of integers

agent_assignment_choice should be 3 List of Agent IDS

agents

teams

array of integers

agent_assignment_choice should be 1 List of Agent IDS

teams

200200

400400