Rate this page:

InitCampaignRequestType

Fields

caller_id

Copy URL
caller_id: 

integer

Caller ID. The ID сan be retrieved via the searchCallerIDs method.

date_end

Copy URL
date_end: 

string

Date when the calls end. Specify it along with the time_end parameter.

date_start

Copy URL
date_start: 

string

Date when the API starts calling customers. Specify it along with the time_start parameter.

description

Copy URL
description: 

string

Campaign description

interval

Copy URL
interval: 

integer

Time between attempts to call one phone number.

max_attempts

Copy URL
max_attempts: 

integer

Maximum number of calls to one phone number.

max_lines

Copy URL
max_lines: 

integer

Maximum number of calls performed simultaneously

permanent

Copy URL
permanent: 

boolean

Set 'true' to make the campaign permanent. Set 'false' to stop the campaign after the end of the calls.

phone_number_id

Copy URL
phone_number_id: 

integer

Phone number ID. The ID сan be retrieved via the searchNumbers method.

scenario_id

Copy URL
scenario_id: 

integer

Scenario ID. The ID can be retrieved via the searchScenarios method.

time_end

Copy URL
time_end: 

string

Time when the calls end. Specify it along with the date_end parameter.

time_start

Copy URL
time_start: 

string

Time when the API starts calling customers. Specify it along with the date_start parameter.

title

Copy URL
title: 

string

Title of the campaign.