...
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"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: Click-2-Dial 4: IVR |
5: Bridge |
6: Ping |
7: Inbound |
8: Coach |
9: Interaction | ||
active | boolean | Wether the campaign will be active or not when created. |
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 |
caller_id | integer | The number which is presented to the customer when the call is dialled. |
target_drop_percentage | decimal | 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. |
user_login_message | 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. |
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 | integer | When a call is connected to an User we can play a tone or audio file in their ear. |
zip_tone_beep | integer | Is it a tone, if so, which tone do you want to play. |
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. |
hide_number | boolean | When placing a call the Campaign will not present a number. |