Примеры использования API звонков

Для использования API нужно создать токен доступа, который можно получить в личном кабинете, раздел "Звонки/Интеграция".

1. Добавление задачи на звонок

 

Запрос на добавление задач передаётся методом POST, параметры нужно передать в теле запроса в формате JSON.

curl -X POST "https://api.chatflow.ru/api/v1/auto-call/tasks" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ТОКЕН-ДОСТУПА" \
-d '{"campaign_id": 3, "phone": "+7900000000000", "params": \ 
{"address": "улица Ленина 1", "debt_amount":"2345 рублей"}}'

 

Пример для 1С

HTTPСоединение = Новый HTTPСоединение("https://api.chatflow.ru");
    запросPOST = Новый HTTPЗапрос("/api/v1/auto-call/tasks");
    запросPOST.Заголовки.Вставить("Accept","application/vnd.api+json");
    запросPOST.Заголовки.Вставить("Content-type","application/json");
    запросPOST.Заголовки.Вставить("Authorization","Bearer ТОКЕН-ДОСТУПА");
    СтрокаJS =     
    "{
    |    ""campaign_id"": ""1"",
    |    ""phone"": ""+790000000000"",
    |    ""params"": {
    |      ""address"": ""улица Ленина 1"",
    |      ""debt_amount"": ""2345 рублей"",
    |    }
    |}";
    Сообщить(СтрокаJS);
    запросPOST.УстановитьТелоИзСтроки(СтрокаJS,"utf-8",ИспользованиеByteOrderMark.НеИспользовать);
    Попытка
        HTTPСоединение.ОтправитьДляОбработки(запросPOST, ФайлОтвета);
    Исключение
        #Если клиент Тогда
           Сообщить(ОписаниеОшибки());
        #КонецЕсли   
    КонецПопытки;

 

Дополнение по принимаемым параметрам

Для удобного создания уведомлений по оплатам,  для переменной с названием "debt_amount" добавен обработчик.
Если приходит просто число с дробной частью или без, дробная часть убирается и добавляется слово "рублей" с соответствующим склонением.  
 Если в значении параметра  указано, помимо числа ещё какой то текст, то будет озвучено как пришло в значении параметра, без изменений. Т.е. если нужно будет указывать копейки или округлять как вам удобно, то присылайте значение с дополнительным с текстом.
Если в параметре "debt_amount" указано просто число, то слово "рублей" автоматом добавиться.
 

 

 

2. Просмотр списка задач

Получение задач передаётся методом GET и параметры можно передать только в теле URL.

curl -X GET "https://api.chatflow.ru/api/v1/auto-call/tasks?campaign_id=1" \
-H "Authorization: Bearer ТОКЕН-ДОСТУПА"

Если в ответе пришёл параметр "pages_count" - это количество страниц.
Например: {"data":{"items_count":90,"pages_count":3,"items": ...}
 
Перебрать страницы можно добавив параметр "p":
1. https://api.chatflow.ru/api/v1/auto-call/tasks?campaign_id=3&p=1
2. https://api.chatflow.ru/api/v1/auto-call/tasks?campaign_id=3&p=2
3. https://api.chatflow.ru/api/v1/auto-call/tasks?campaign_id=3&p=3

 

 

3. Удаление задач на звонок

Метод для удаления задач. В параметрах указываются id задач на обзвон, которые нужно удалить. Если задача уже отработана, то удаление не состоится.

curl -X DELETE "https://api.chatflow.ru/api/v1/auto-call/tasks" \
-d '[{"id":458}, {"id":459}]' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ТОКЕН-ДОСТУПА"

В ответ возвращает массив объектов удалённых задач: [{"id":458,..},..]