Create Campaign

Create a new campaign

Method: POST
Endpoint: /omni/campaign
System Authorization: Authorization: Key=your-auth-key
User Authentication: tokenKey: {token}

{
  "campaign_name": <string>,
  "campaign_type": <string>,
  "description": <string>,
  "teleparam_plan_id": <integer>,
  "caller_id": <string>,
  "target_drop_percentage": <integer>,
  "message_of_the_day": <string>,
  "default_list_id": <integer>,
  "default_phone_type": <integer>,
  "auto_record": <boolean>,
  "is_blended": <boolean>,
  "degrade_to_progressive": <boolean>,
  "not_ready_wait_time": <integer>,
  "zip_tone": <string>,
  "zip_tone_beep": <string>,
  "zip_tone_wav": <string>,
  "max_lines": <integer>,
  "schedule_plan_id": <integer>,
  "hours_per_working_day": <decimal>,
  "progressive_threshold": <integer>
}

Field	Type	Description

Field	Type	Description
campaign_name	string	The name of the campaign to be created.
campaign_type	string	The type of campaign to be created. Predictive Progressive Click-2-Dial IVR Bridge Ping Inbound Coach Interaction
description	string	The description of the camapign
teleparam_plan_id	integer	This what defines the dialling parameters for the campaign, e.g., no answer time, which carrier the call is placed over etc. The default is 1 unless specified otherwise.
caller_id	string	The number which is presented to the customer when the call is dialled.
target_drop_percentage	integer	A campaign has a set value for dropped calls, the system will ensure that calls will be made to keep users occupied without exceeding this drop rate.
message_of_the_day	string	When a user logs in to a Campaign you can present a message to that User
default_list_id	integer	The default list ID. The default is 1 unless specified otherwise.
is_blended	boolean	Wether the campaign is a blended campaign or not.
degrade_to_progressive	boolean	A Campaign can be configured to have a threshold of Agents, when there is less than this number of Agents the Campaign will dial progressively if there are more than this number it will dial predictively.
not_ready_wait_time	integer	This is how long a user can spend in the ready status before going not ready. This is to prevent dropped calls.
zip_tone	string	When a call is connected to an User we can play a tone or audio file in their ear. beep WavFile None
zip_tone_beep	string	Is it a tone, if so, which tone do you want to play. This needs to be set even is zip_tone is “None“. High Low HiLo LoHi HiLoHi LoHiLo Twinkle Beethoven Bingo OldMacDonald Mary
zip_tone_wav	string	If it is a file, which file do you want to play.
max_lines	integer	When you have created an IVR or Ping Campaign, how many lines can that IVR Campaign use.
schedule_plan_id	integer	These are configured on a per system basis and it will define the dialling hours for the campaign, 0 means no schedule.
default_phone_type	integer	When a new phone number is created via a Click2Dial or Shotgun dial, what type of phone number should it be, Home, Work, Mobile. 0. Home 1. Work 2. Mobile
progressive_threshold	Integer	This feature allows you to restrict dialling to progressive when less than the configured number of agents are logged into a predictive campaign. Instead of dialling predictively, the campaign will automatically change to dial in progressive mode. This feature is particularly useful for contact centres struggling with dropped calls at break times as agents log off or with reduced shifts.
auto_record	boolean	This set the call recording auto either on(true) or off(false).
hours_per_working_day	decimal	The amount of hours a user can be logged into a campaign for.