Campaign Add
This service is used to add a campaign.
Parameters
| Description | Defined Data | Example Data | Required[**]/Optional[*] | Parameters |
|---|---|---|---|---|
| Campaign Name | - | test | ** | name |
| Unique Trunk ID obtained from search | - | 5f6c5b56c92de0068f32e592 | ** | trunk_manager_id |
| Context value in autodialer component route | - | auto | interface_context | |
| Text value in autodialer component route | - | text1 | interface_text | |
| Phone Numbers | - | 09212396500 | * | numbers |
| Unique Group ID obtained from search | - | "5e96c8c2c92de0468920657e", "5e96d40cc92de025690d0a61" | * | groups |
| Time interval between each attempt | - | 600 | * | try_interval |
| Number of retries | - | 1 | * | try |
| Campaign Start Time | - | 2021-02-19 15:17 | * | start |
| Campaign End Time | - | 2021-02-23 15:17 | * | end |
| Unique Audio File ID obtained from search | - | 5e5b629ec92de075df7af457 | * | announcement |
| Description | - | - | description |
Sample Invocation
- Example Code To Use
- Example Output
- PHP
- JS
- Curl
Show Full Source Code PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "http://192.168.51.21/api/v4/autodialer/campaigns/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS =>"{\r\n \"name\":\"test\",\r\n \"trunk_manager_id\":\"5f6c5b56c92de0068f32e592\",\r\n \"interface_context\":\"auto\",\r\n \"interface_text\":\"text1\",\r\n \"numbers\":[\"09212396500\"],\r\n \"groups\":[\"5e96c8c2c92de0468920657e\",\"5e96d40cc92de025690d0a61\"],\r\n \"try_interval\":\"600\",\r\n \"try\":\"1\",\r\n \"start\":\"2021-02-19 15:17\",\r\n \"end\":\"2021-02-23 15:17\",\r\n \"announcement\":\"5e5b629ec92de075df7af457\",\r\n \"description\":\"\",\r\n \"count\":3\r\n}",
CURLOPT_HTTPHEADER => array(
"X-APIKEY: vZKtIKWsld0egNlkzHo8i5LVBqLNBSWARCQsPOSgDjFmAHM3tG",
"Authorization: Basic dGVzdDpBYTEyMzQ1Ng==",
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
if (!curl_errno($curl)) {
$httpcode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
echo 'response code:'.$httpcode, '<br/>';
}
curl_close($curl);
echo $response;
?>
Show Full Source Code JS
<html>
<head>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
</head>
<body>
<script>
var settings = {
"url": "http://192.168.51.21/api/v4/autodialer/campaigns/add",
"method": "POST",
"timeout": 0,
"headers": {
"X-APIKEY": "vZKtIKWsld0egNlkzHo8i5LVBqLNBSWARCQsPOSgDjFmAHM3tG",
"Authorization": "Basic dGVzdDpBYTEyMzQ1Ng==",
"Content-Type": "application/json"
},
"data": JSON.stringify({
"name": "test",
"trunk_manager_id": "5f6c5b56c92de0068f32e592",
"interface_context": "auto",
"interface_text": "text1",
"numbers": [
"09212396500"
],
"groups": [
"5e96c8c2c92de0468920657e",
"5e96d40cc92de025690d0a61"
],
"try_interval": "600",
"try": "1",
"start": "2021-02-19 15:17",
"end": "2021-02-23 15:17",
"announcement": "5e5b629ec92de075df7af457",
"description": "",
"count": 3
}),
};
$.ajax(settings).always(function (jqXHR) {
console.log("response code: " + jqXHR.status + " " + jqXHR.statusText);
console.log("response body: " + jqXHR.responseText);
});
</script>
</body>
</html>
Show Full Source Code Curl
curl --location --request POST 'http://192.168.51.21/api/v4/autodialer/campaigns/add' \
--header 'X-APIKEY: vZKtIKWsld0egNlkzHo8i5LVBqLNBSWARCQsPOSgDjFmAHM3tG' \
--header 'Authorization: Basic dGVzdDpBYTEyMzQ1Ng==' \
--header 'Content-Type: application/json' \
--data-raw '{
"name":"test",
"trunk_manager_id":"5f6c5b56c92de0068f32e592",
"interface_context":"auto",
"interface_text":"text1",
"numbers":["09212396500"],
"groups":["5e96c8c2c92de0468920657e","5e96d40cc92de025690d0a61"],
"try_interval":"600",
"try":"1",
"start":"2021-02-19 15:17",
"end":"2021-02-23 15:17",
"announcement":"5e5b629ec92de075df7af457",
"description":"",
"count":3
}'
{
"success": 1,
"message": "Requested operation is done successfully",
"data": {
"_id": "654338c7766d71477c6319c3"
}
}