Перейти к основному контенту

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

Translator

 

Translator



Описание

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

Эндпоинт

POST
https://ai-assistant.is74.ru/api/campaigns

## Запрос
### Тело запроса (JSON)
{
  "campaign": {
    "project_id": 0,
    "name": "string",
    "description": "",
    "start_block_id": 0,
    "schedule": {
      "date": "2021-10-06",
      "start_time": "07:30",
      "end_time": "19:00",
      "periods": {"id": 1, "title": "Однократно"},
      "attempts": {"id": 1, "title": "1"},
      "interval": "0"
    },
    "state": "Создано",
    "phone_id": 0
  },
  "phones": [
    {
      "phone": "string",
      "add_data": {}
    }
  ]
}


###

Параметры запроса
-

  • project_id (integer): ID проекта
    -

  • name (string): Название обзвона
    -

  • description (string): Описание обзвона
    -

  • start_block_id (integer): ID стартового блока сценария
    -

  • schedule (object): Расписание обзвона

      -

    • date (string): Дата начала обзвона (формат: ГГГГ-ММ-ДД)

      • -

    • start_time (string): Время начала обзвона (формат: ЧЧ:ММ)

      • -

    •  end_time (string): Время окончания обзвона (формат: ЧЧ:ММ)

      • -

    • periods (object): Периодичность обзвона

      • -

    • attempts (object): Количество попыток дозвона на номер

      • -

    • interval (string): Время в минутах между попытками дозвона
      -

  • state (string): Статус обзвона
    -

  • phone_id (integer): ID номера телефона, с которого звонить


###

### Пример запроса
{
  "campaign": {
    "project_id": 1,
    "name": "Обзвон клиентов",
    "description": "Обзвон клиентов для опроса удовлетворенности",
    "start_block_id": 10,
    "schedule": {
      "date": "2021-10-06",
      "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": "+79123456789",
      "add_data": {"name":"Иванов Иван", "time":"10:00", "phone": 123456}
    }
  ]
}


## Ответ
### Успешный ответ
**Код:** 200

**Тело ответа**
{
  "campaign": {
    "id": 12345
  }
}


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

## Пример использования
curl -X POST https://ai-assistant.is74.ru/api/campaigns \
-H 'Content-Type: application/json' \
-d '{
  "campaign": {
    "project_id": 1,
    "name": "Обзвон клиентов",
    ...
  },
  ...
}'


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

Translator




Наверх