Адаптер совместимости V2 → V4
Адаптер совместимости принимает запросы клиентов старой платформы V2 в их прежней форме и превращает их в кампании V4. Клиент не меняет ни тела запросов, ни разбор ответов: он шлёт всё тот же JSON по своему прежнему адресу, а звонит уже текущая платформа.Для кого эта инструкция. Для клиентов V2, которые продолжают слать API-запросы в форме V2, для их интеграторов и для сотрудников платформы, которые заводят таких клиентов и следят за их кампаниями: администраторов корневой организации и разработчиков агентов.
Как это работает
Клиент V2 продолжает слать запросы по своему прежнему адресу, а платформа направляет их в адаптер. Клиент входит логином и паролем V2, которые заведены как учётная запись адаптера.- Запрос
createпроходит те же проверки, что в V2, и становится кампанией в организации учётной записи. Один набор признаков «учётная запись, скрипт, имя, час старта, день, попытки» даёт одну кампанию в день; следующие запросы с теми же признаками добавляют в неё партии звонков. deleteиdelete_phone_numberснимают контакты с обзвона.detailsотдаёт выгрузку звонков за день по шаблону отчёта.- Поля строки запроса становятся переменными агента по карте из реестра совместимости.
Что настраивается до первого запроса
Перед первым запросом клиента администратор платформы заводит:- учётную запись адаптера — логин и пароль клиента из V2, организацию V4, в которой будут жить его кампании, и дефолты обзвона на случай, когда запрос не передал параметр. Как её завести — Учётные записи адаптера;
- реестр совместимости — по одной строке на каждое имя скрипта, которое клиент шлёт в
data[].type: какой агент звонит, какие поля несёт строка запроса и как они попадают к агенту. Как его собрать — Реестр совместимости.
Термины
Пометка «в логах»
Иногда причина отказа видна только в журнале приложения, а не в кабинете. В инструкции такие места помечены словами «в логах». Журнал читают инженеры платформы: если нужен такой разбор, передайте им логин клиента, операцию и время запроса. Всё, что можно увидеть в кабинете, описано через кабинет. Что именно пишется в журнал — в разделе Что видно только в логах.Разделы
API для клиента V2
Адрес, тело запроса, вход и лимиты, операции
create, delete, details, отличия от V2.Настройка
Учётные записи адаптера и реестр совместимости: заведение, поля и переменные, правила повторов.
Мониторинг
Как найти кампанию адаптера, контакты, снятия, звонки и выгрузки.
FAQ
Что идёт не так: переменные, пустая очередь, часы, вебхуки, вход.