# Создание обзвонов

<div class="translate-tooltip-mtz translator-hidden" id="bkmrk-translator-%C2%A0"></div><div class="translate-tooltip-mtz translator-hidden" id="bkmrk-translator"></div>#### Описание  


API позволяет создавать обзвоны с заданными параметрами.

Данная документация описывает API для создания обзвона с указанными параметрами. В случае успешного создания обзвона будет возвращен ID созданного обзвона для последующего получения результатов.

<table border="1" class="align-center" id="bkmrk-post-https%3A%2F%2Fai-assi" style="border-collapse: collapse; width: 101.111%; height: 474.9px; border-width: 1px; background-color: rgb(255, 255, 255); border-color: rgb(255, 255, 255);"><colgroup><col style="width: 12.8554%;"></col><col style="width: 87.1446%;"></col></colgroup><tbody><tr style="height: 70.85px;"><td class="align-left" style="height: 70.85px; border-color: rgb(255, 255, 255);">##### <span class="api-method text-mono" data-method="POST">POST</span>

</td><td class="align-center" style="height: 70.85px; border-color: rgb(255, 255, 255);">##### `https://ai-assistant.is74.ru/api/campaigns`

</td></tr><tr style="height: 404.05px;"><td class="align-left" colspan="2" style="border-color: rgb(255, 255, 255); height: 404.05px;">```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"},
    "state": "Создано",
    "phone_id": 0
  },
  "phones": [
    {
      "phone": "string",
      "add_data": {}
    }
  ]
}
```

<p class="callout info">В **add\_data** передаются json {ключ: значение}, где ключ является параметром из стартового блока сценария </p>

</td></tr></tbody></table>

<details id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-ca"><summary>Параметры запроса</summary>

<table class="table" style="width: 100%; height: 314.067px;"><tbody><tr style="height: 41.8px;"><th style="width: 29.7818%; height: 41.8px;">Campaign</th><th style="width: 25.0285%; height: 41.8px;">Value Rules</th><th style="width: 45.1898%;">Description</th></tr><tr style="height: 42.4667px;"><td style="width: 29.7818%; height: 42.4667px;">project\_id</td><td style="width: 25.0285%; height: 42.4667px;">`required` `integer`   
</td><td style="width: 45.1898%;">ID проекта</td></tr><tr style="height: 42.4667px;"><td style="width: 29.7818%; height: 42.4667px;">name</td><td style="width: 25.0285%; height: 42.4667px;">`string` </td><td style="width: 45.1898%;">Название обзвона</td></tr><tr style="height: 42.4667px;"><td style="width: 29.7818%; height: 42.4667px;">description</td><td style="width: 25.0285%; height: 42.4667px;">`string` </td><td style="width: 45.1898%;">Описание обзвона</td></tr><tr style="height: 42.4667px;"><td style="width: 29.7818%; height: 42.4667px;">start\_block\_id</td><td style="width: 25.0285%; height: 42.4667px;">`required` `integer`</td><td style="width: 45.1898%;">ID стартового блока сценария</td></tr><tr><td style="width: 29.7818%;">schedule</td><td style="width: 25.0285%;">`required``json`   
</td><td style="width: 45.1898%;">Расписание обзвона</td></tr><tr><td style="width: 29.7818%;">state</td><td style="width: 25.0285%;">`string` </td><td style="width: 45.1898%;">Статус обзвона.

Всегда выставлять значение: "Создано"

</td></tr><tr><td style="width: 29.7818%;">phone\_id</td><td style="width: 25.0285%;">`required` `integer`</td><td style="width: 45.1898%;">ID номера телефона, с которого звонить</td></tr></tbody></table>

<details><summary>Schedule</summary>

<table class="table" style="width: 100%; height: 361.467px;"><tbody><tr style="height: 41.8px;"><th style="width: 29.6534%; height: 41.8px;">Schedule</th><th style="width: 25.2888%; height: 41.8px;">Value Rules</th><th style="width: 45.0578%; height: 41.8px;">Description</th></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">date</td><td style="width: 25.2888%; height: 42.4667px;">`required` `string`</td><td style="width: 45.0578%; height: 42.4667px;">Дата начала обзвона (формат: ГГГГ-ММ-ДД)</td></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">start\_time</td><td style="width: 25.2888%; height: 42.4667px;">`required` `string`</td><td style="width: 45.0578%; height: 42.4667px;">Время начала обзвона (формат: ЧЧ:ММ)</td></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">end\_time</td><td style="width: 25.2888%; height: 42.4667px;">`required` `string`</td><td style="width: 45.0578%; height: 42.4667px;">Время окончания обзвона (формат: ЧЧ:ММ)</td></tr><tr style="height: 59.9333px;"><td style="width: 29.6534%; height: 59.9333px;">periods</td><td style="width: 25.2888%; height: 59.9333px;">`required``json`</td><td style="width: 45.0578%; height: 59.9333px;">Периодичность обзвона</td></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">attempts</td><td style="width: 25.2888%; height: 42.4667px;">`required``json`</td><td style="width: 45.0578%; height: 42.4667px;">Количество попыток дозвона на номер</td></tr><tr style="height: 47.4px;"><td style="width: 29.6534%; height: 47.4px;">interval

</td><td style="width: 25.2888%; height: 42.4667px;">`required` `string`</td><td style="width: 45.0578%; height: 47.4px;">Время в минутах между попытками дозвона</td></tr></tbody></table>

<details><summary>Periods</summary>

<table class="table" style="width: 100%; height: 126.733px;"><tbody><tr style="height: 41.8px;"><th style="width: 29.6534%; height: 41.8px;">Periods</th><th style="width: 25.2888%; height: 41.8px;">Value Rules</th><th style="width: 45.0578%; height: 41.8px;">Description</th></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">id  
</td><td style="width: 25.2888%; height: 42.4667px;">`required` `integer`  
</td><td style="width: 45.0578%; height: 42.4667px;">Всегда выставлять значение: 1  
</td></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">title</td><td style="width: 25.2888%; height: 42.4667px;">`required` `string`</td><td style="width: 45.0578%; height: 42.4667px;">Всегда выставлять значение: "Однократно"  
</td></tr></tbody></table>

</details><details><summary>Attempts</summary>

<table class="table" style="width: 100%; height: 319px;"><tbody><tr style="height: 41.8px;"><th style="width: 29.6534%; height: 41.8px;">**Attempts**</th><th style="width: 25.2888%; height: 41.8px;">Value Rules</th><th style="width: 45.0578%; height: 41.8px;">Description</th></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">id  
</td><td style="width: 25.2888%; height: 42.4667px;">`required` `integer`  
</td><td style="width: 45.0578%; height: 42.4667px;">Значения от "1" до "5".

Значение в id соответствует значению в title.

</td></tr><tr style="height: 42.4667px;"><td style="width: 29.6534%; height: 42.4667px;">title</td><td style="width: 25.2888%; height: 42.4667px;">`required` `string`</td><td style="width: 45.0578%; height: 42.4667px;">Значения от "1" до "5".

Значение в title соответствует значению в id.

</td></tr></tbody></table>

</details></details></details><details id="bkmrk-%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-%7B-%C2%A0-%22"><summary>Пример запроса</summary>

```json
{
  "campaign": {
    "project_id": 1,
    "name": "Обзвон клиентов",
    "description": "Обзвон клиентов для опроса удовлетворенности",
    "start_block_id": 10,
    "schedule": {
      "date": "2000-01-01",
      "start_time": "09:00",
      "end_time": "17:00",
      "periods": {"id": 1, "title": "Однократно"},
      "attempts": {"id": 1, "title": "1"},
      "interval": "5"
    },
    "state": "Создано",
    "phone_id": 5
  },
  "phones": [
    {
      "phone": "+79999999999",
      "add_data": {"name":"Иванов Иван", "time":"10:00", "phone": 123456}
    }
  ]
}
```

</details><details id="bkmrk-%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-%D0%9A%D0%BE%D0%B4%3A-2"><summary>Пример ответа</summary>

**Код: <span style="color: rgb(45, 194, 107);">200</span>**

```json
{
  "campaign": {
    "id": 12345
  }
}
```

**Ошибки**

- В случае ошибки будет возвращен соответствующий HTTP статус код и сообщение об ошибке.

</details>