# Создание обзвонов
#### Описание API позволяет создавать обзвоны с заданными параметрами. Данная документация описывает API для создания обзвона с указанными параметрами. В случае успешного создания обзвона будет возвращен ID созданного обзвона для последующего получения результатов.##### POST | ##### `https://ai-assistant.is74.ru/api/campaigns` |
```json
{
"campaign": {
"project_id": 0,
"name": "string",
"description": "string",
"start_block_id": 0,
"schedule": {
"date": "string",
"start_time": "string",
"end_time": "string",
"periods": {"id": 1, "title": "Однократно"},
"attempts": {"id": 1, "title": "1"},
"interval": "string"},
"phone_id": 0
},
"phones": [
{
"phone": "string",
"add_data": {}
}
]
}
```
В **add\_data** передаются json {ключ: значение}, где ключ является параметром из стартового блока сценария |
Campaign | Value Rules | Description |
---|---|---|
project\_id | `required` `integer` | ID проекта |
name | `string` | Название обзвона |
description | `string` | Описание обзвона |
start\_block\_id | `required` `integer` | ID стартового блока сценария |
schedule | `required``json` | Расписание обзвона |
phone\_id | `required` `integer` | ID номера телефона, с которого звонить |
Schedule | Value Rules | Description |
---|---|---|
date | `required` `string` | Дата начала обзвона (формат: ГГГГ-ММ-ДД) |
start\_time | `required` `string` | Время начала обзвона (формат: ЧЧ:ММ) |
end\_time | `required` `string` | Время окончания обзвона (формат: ЧЧ:ММ) |
periods | `required``json` | Периодичность обзвона |
attempts | `required``json` | Количество попыток дозвона на номер |
interval | `required` `string` | Время в минутах между попытками дозвона |
Periods | Value Rules | Description |
---|---|---|
id | `required` `integer` | Всегда выставлять значение: 1 |
title | `required` `string` | Всегда выставлять значение: "Однократно" |
**Attempts** | Value Rules | Description |
---|---|---|
id | `required` `integer` | Значения от "1" до "5". Значение в id соответствует значению в title. |
title | `required` `string` | Значения от "1" до "5". Значение в title соответствует значению в id. |