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

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

Translator

 

Translator




Translator



Описание

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

Э

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

атов.

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": {}
    }
  ]
}

 

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


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".

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

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

  • 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"79999999999",
 
      "add_data": {"name":"Иванов Иван", "time":"10:00", "phone": 123456}
 
    }
 
  ]

}


##

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

**Телор ответа**

Код: 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




































 


 


 


 


 


 


 

    
        

    


            

        

    


    


    
    

        

             Наверх