Campaign Add
از این سرویس برای افزودن کمپین استفاده میشود.
پارامترها
| پارامترها | پارامترهای ضروری[**]/منطقی[*] | دادههای نمونه | توضیحات | دادههای تعریف شده |
|---|---|---|---|---|
| name | ** | test | نام کمپین | - |
| trunk_manager_id | ** | 5f6c5b56c92de0068f32e592 | شناسه یکتا ترانک که از جستوجو به دست میآید | - |
| interface_context | auto | مقدار context در کامپوننت autodialer route | - | |
| interface_text | text1 | مقدار text در کامپوننت autodialer route | - | |
| numbers | * | 09123456789 | شماره مخاطبین | - |
| groups | * | "5e96c8c2c92de0468920657e" "5e96d40cc92de025690d0a61" | شناسه یکتا گروه که از جستوجو به دست میآید | - |
| try_interval | * | 600 | فاصله زمانی بین هر تلاش | - |
| try | * | 1 | تعداد تکرار | - |
| start | * | 2021-02-19 15: 17 | زمان شروع کمپین | - |
| end | * | 2021-02-23 15: 17 | زمان پایان کمپین | - |
| announcement | * | 5e5b629ec92de075df7af457 | شناسه یکتا فایل صوتی که از جستوجو به دست میآید | - |
| description | - | توضیحات | - |
نمونه فراخوانی
Example 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\": [\"09123456789\"],\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: SAMPLE_API_KEY",
"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;
?>
JavaScript
<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": [
"09123456789"
],
"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>
cURL
curl --location --request POST 'http: //192. 168. 51. 21/API/v4/autodialer/campaigns/add' \
--header 'X-APIKEY: SAMPLE_API_KEY' \
--header 'Authorization: Basic dGVzdDpBYTEyMzQ1Ng==' \
--header 'Content-Type: application/JSON' \
--data-raw '{
"name": "test",
"trunk_manager_id": "5f6c5b56c92de0068f32e592",
"interface_context": "auto",
"interface_text": "text1",
"numbers": ["09123456789"],
"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
}'
```
</details>
</details>
</div>
</details>
<details><summary>Example Output</summary>
```shell
{
"success": 1,
"message": "Requested operation is done successfully",
"data": {
"_id": "654338c7766d71477c6319c3"
}
}