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

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

Описание

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

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

POST
https://ai-assistant.is74.ru/api/campaigns
 
{
  "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": {}
    }
  ]
}

В add_data передаются json {ключ: значение}, где ключ является параметром из стартового блока сценария 
Параметры запроса

 


Campaign Value Rules Description
project_id required integer
ID проекта
name string  Название обзвона
description string  Описание обзвона
start_block_id required integer ID стартового блока сценария
schedule requiredjson
Расписание обзвона
state string 

Статус обзвона.

Всегда выставлять значение: "Создано"
phone_id required integer ID номера телефона, с которого звонить
Schedule
Schedule Value Rules Description
date required string Дата начала обзвона (формат: ГГГГ-ММ-ДД)
start_time required string Время начала обзвона (формат: ЧЧ:ММ)
end_time required string Время окончания обзвона (формат: ЧЧ:ММ)
periods requiredjson Периодичность обзвона
attempts requiredjson Количество попыток дозвона на номер

interval

 required string Время в минутах между попытками дозвона
Periods
Periods Value Rules Description
id
 required integer
 Всегда выставлять значение: 1
title required string Всегда выставлять значение: "Однократно"
Attempts

 

 

Attempts Value Rules Description
id
 required integer

Значения от "1" до "5".

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

Значения от "1" до "5".

Значение в title соответствует значению в id.
Пример запроса 
{
  "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}
    }
  ]
}
Пример ответа

Код: 200

{
  "campaign": {
    "id": 12345
  }
}

Ошибки

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

 

Наверх