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": <integer>,
"active": <boolean>,
"description": <string>,
"teleparam_plan_id": <integer>,
"caller_id": <string>,
"target_drop_percentage": <decimal>,
"motd": <string>,
"default_list_id": <integer>,
"default_phone_type": <integer>,
"default_email_type": <integer>,
"auto_record": <boolean>,
"is_blended": <boolean>,
"degrade_to_progressive": <boolean>,
"not_ready_wait_time": <integer>,
"zip_tone": <integer>,
"zip_tone_beep": <integer>,
"zip_tone_wav": <string>,
"skill_based_routing": <boolean>,
"max_lines": <integer>,
"schedule_plan_id": <integer>,
"dynamic_nail_up": <boolean>,
"withhold_number": <boolean>
} |
Field | Type | Description |
|---|---|---|
campaign_name | string | The name of the campaign to be created. |
campaign_type | integer | The type of campaign to be created. 1: Progressive 2: Preview 3: IVR 4: Bridge 5: Ping 6: Inbound 7: Coach 8: Interaction |
active | boolean | Wether the campaign will be active or not when created. |
description | string | The description of the camapign |
teleparam_plan_id | integer | TBA |
caller_id | integer | TBA |
target_drop_percentage | decimal | TBA |
motd | string | TBA |
default_list_id | integer | The default list ID. |
default_phone_type | integer | TBA |
default_email_type | integer | TBA |
auto_record | boolean | TBA |
is_blended | boolean | Wether the campaign is a blended campaign or not. |
degrade_to_progressive | boolean | TBA |
not_ready_wait_time | integer | TBA |
zip_tone | integer | TBA |
zip_tone_beep | integer | TBA |
zip_tone_wav | string | TBA |
skill_based_routing | boolean | TBA |
max_lines | integer | TBA |
schedule_plan_id | integer | TBA |
dynamic_nail_up | boolean | TBA |
withhold_number | boolean | TBA |