1. Получение токена для авторизации
Важно:
- У токена есть время жизни
- Рекомендуем устанавливать время жизни токена 24 часа и обновлять за 15 минут до окончания
- Также токен нужно обновлять при получении 403 ошибки от любого метода Twin
- Для обновления можно использовать тот же метод или метод обновления по рефреш токену
2. Создание задания на обзвон
Важно:
- Рекомендуем создавать одно задание по одному шаблону на сутки для одной интеграции и наполнять его кандидатами
- Настройки задания можно либо кастомизировать на стороне интеграции, либо получить по id шаблона отдельным методом
3. Добавление кандидатов в обзвон
Важно:
- Если указать forceStart = true, то обзвон начнется автоматически после добавления всех кандидатов
- Начинать добавлять кандидатов в обзвон нужно не ранее, чем через 5 секунд после его создания
- Рекомендуем добавлять сразу большое количество кандидатов одним запросом, а не по одному кандидату
(Например: сохраняете кандидатов себе во временное хранилище/базу и раз в 5 минут добавляете всех кандидатов в задание)
4. Старт/пауза/остановка задания
Данный шаг не обязательный, если на шаге 3 указать forceStart = true
Важно:
- Стартовать задание рекомендуем не ранее чем через 15 секунд после добавления кандидатов
- Стартовать уже запущенное задание еще раз не требуется
- Статус задания можно получить отдельным методом
- Редактировать задание после паузы не рекомендуется. Лучше создать новое задание.
- Остановка задания делает его недоступны для запуска и добавления кандидатов, но статистику по нему получить все еще можно
5. Получение статистики:
- Хук после каждого звонка (для исходящих урл настраивается в задании на обзвон, для входящих в настройках номера в интерфейсе TWIN)
- Метод для получения статистики
Важно:
- Рекомендуем получать статистику именно с помощью хуков (это более удобный и надежный способ)
- Метод для получения статистики рекомендуем использовать только в тех случаях, когда нет необходимости в получение данных о звонках "здесь и сейчас" (например: обзвон работает весь день, а далее его результаты забираются ночью)
- Для загрузки аудиозаписей во внешнюю систему можно воспользоваться отдельным методом