Array of listSid. Up to 5 listSid can be part of one single campaign if optional parameter campaign type is selected as "static". If optional parameter campaign type is selected as "dynamic" then only one listSid is allowed. If no campaign type parameter is selected then the campaign by default runs as a "static" campaign. Either 'from' parameter or 'lists' parameter should be present in the API request

This will be "static" by default. In case, a Dynamic Campaign has to be scheduled then this value will be "dynamic"

In case of Creating an IVR through the campaign module, defining "ivr" is mandatory. The parameter name is "ivr". If read_via_text is opted then this value will be "greeting". 

This is not applicable if you are selecting a flow.

If the flow_type is selected as "ivr" then this value can be specified to repeat the IVR menu.

The default value will be 0 if the flow_type is set as "ivr". 

This field is not applicable if flow_type is "greeting"

Only applicable if you are selecting a call flow. 

http://my.exotel.com/{your_sid}/exoml/start_voice/{app_id} where app_id is the identifier of the flow (or applet) that you want to connect to once the from number picks up the call. You can get the app_id from your Exotel Dashboard

If the flow_type is opted for "ivr" or "greeting", then this field has to be entered with the content that has to be played out to the caller. You can enter a static content(no variables) or Dynamic content. In case, dynamic content is entered then "@@" has to be entered with the header value. Ensure that the header is the exact match from the list uploaded. For ex: If the header name in the file is FirstName then in the content entered here the dynamic variable has to be "@@FirstName"

If flow/url is opted then this field would not be required. 

It's an optional parameter in the request but mandatory in the response. It is used to define the name of the campaign. It should be greater than 3 characters and if not passed, its default value will be created using the 'AccountSID CurrentDate CurrentTime' and passed in the response.

Example: exotel 2021-06-04 11:11:10

It's an optional parameter in the request but mandatory in the response. It's allowed (and default) value is 'trans'. If not passed in the request, we will create campaign as type 'trans' and pass this parameter in the API response. As per regulations, we support only transactional type of campaigns.

call_duplicate_numbers

Type: boolean

Allowed Values: 'true' & 'false'

Default Value: 'false'

If 'true', Campaign will try calling the duplicate numbers present in the list(s). If 'false', Campaign will call any number in the list(s) only once. It is independent of the 'retry' functionality.

Object;Retry logic in case the calls are not successful.

• number_of_retries - The number of times a call to a phone number should be attempted. Default is 0 and max is 3.
• interval_mins - The time interval between retries in mins. Mandatory when number_of_retries is specified
• mechanism - either "Linear" or "Exponential". If the retry should be equally spaced or exponentially. Default is linear.
• on_status - Array; Determines when should campaign treat a call as an unsuccessful attempt. Could be "busy", "no-answer", "failed"

Array;Determines when to start and end a campaign in RFC 3339 date-time

• send_at - Time when the campaign should start. Default is to start now.
• end_at - Time when the campaign should end even if all calls are not attempted as part of the campaign. Default +30 days from now or send_at time. This time is always strictly adhered to even there are calls pending to be made

When the call completes, an HTTP POST will be made to the provided URL with the following four parameters:

• campaign_sid - an alpha-numeric unique identifier of this campaign
• call_sid - an alpha-numeric unique identifier of this call
• date_created - time when the resource was created
• date_updated - time when the was updated
• number - number to which the call was made
• status - one of: completed, no-answer, busy, failed

When all calls to a number were completed including retries, an HTTP POST will be made to the provided URL with the following four parameters:

• campaign_sid - an alpha-numeric unique identifier of this campaign
• to - the number to which the call was made
• from - the Exophone used in the campaign
• date_created - time when the resource was created
• date_updated - time when the resource was updated
• call_sids - Object; includes all the call_sids and status of the calls that were made as part of this schedule
• status - one of completed, busy, no-answer, failed

When the call campaign starts or ends, an HTTP POST will be made to the provided URL with the following four parameters:

• campaign_sid - an alpha-numeric unique identifier of this campaign
• date_created - time when the campaign resource was created
• date_updated - time when the campaign was updated
• date_started - time when the campaign started
• status - one of: in-progress, completed, failed, canceled
• reports - link to the campaign reports

This can be "auto" or "custom". 

Auto- This will be a default in which the campaign service will distribute the throttle of the campaign automatically

Custom- The throttle value can be set based on the desired campaign priority. 

Only if Mode is selected as "Custom" this parameter will be applicable. The allowed value will be between 1 to (Campaign account throttle minus 1). 

To know your Campaign Account throttle you can visit the Campaign settings page of your Exotel Account. 

JSON array representing the response and contains below parameters:

• code - response code of the block in the response array, can be different from the overall http code, like in case of partial success (207)
• error_data - To be populated in case of errors like below

"error_data": {
    "code": 1000,
    "description": "Not Found",
    "message": "Not Found"
}

In case of no errors, it’ll be null.

• status - success or failure, depicting the status of the block in the response array
• data - This will contain the data part of the block of the response array depending on the API, below table describes what will be populated in case of POST on Campaigns API. Please note, this field can be null also in case of failures like 404.

JSON; The retries that were configured as part of this campaign:

• number_of_retries - The number of times a call to a phone number should be attempted.
• interval_mins - The time interval between retries in mins.
• mechanism - Either "linear" or "exponential". If the retry should be equally spaced or exponentially.
• on_status - Array; When should campaign treat a call as an unsuccesful attempt. Could be "busy", "no-answer", "failed"

JSON; The start and end time that were configured for this campaign:

• send_at - Time when the campaign should start. Default is to start now.
• end_at - Time when the campaign should end even if all calls are not attempted as part of the campaign. Default +30 days from now or send_at time. This time is always stricktly adhered to even there are calls pending to be made

The current status of the campaign. Campaings have both intermediate and final status:

• Created - A campaign resource was created in the system as a result of a succesful POST request to the campaigns end point
• InProgress - The campaign is currently in progress
• completed - The campaign has ended normally
• Failed - None of the calls were made as part of the campaign (5xx/4xx/invalid numbers etc.). Immediate failures are marked as failed as well
• Canceled - The campaign was paused but never resumed and end_at time reached or it expired
• Deleted - The campaign which was deleted before the trigger (scheduled time)
• Paused - The campaign that was scheduled or is in-progress was paused