Читать 6

Подтверждение заявки на стороннем сервисе с помощью API


Общая информация

Функционал позволяет отправлять полученные заявки с виджетов в систему клиента до запуска обратного звонка. Это дает клиенту возможность принять решение о необходимости прозвона таких заявок или их отмене.

Например, чтобы клиент мог самостоятельно отсеивать спам, либо клиентов, с которыми КЦ уже связался ранее.

Для подключения функционала необходимо обратиться к вашему аккаунт-менеджеру либо написать на почту info@calltouch.net

Настройка работает на весь сайт id, для всех виджетов с услугой обратный звонок.

Механика работы

После настройки функционала, при получении заявки, она будет попадать в общую очередь со статусом "Заявка находится на проверке внешним сервисом". Параллельно заявка со всеми данными из формы будет улетать вебхуком в стороннюю систему.

Пример тела запроса

Тело запроса в формате JSON:

{
  "attempt_id""ID попытки (вебхука)",
  "request_created""Время создания заявки, в формате yyyy-mm-dd hh:mm:ss",
  "work_mode""Режим работы виджета (рабочее/не рабочее время)",
  "request_id""ID заявки",
  "client_phone""Номер телефона клиента",
  "form_data": {
    "name""Имя",
    "note""Комментарий",
    "phone""Номер телефона",
    "email""Email",
    "contactUnitGroupId""ID группы отделов",
    "contactUnitGroupTitle""Название группы отделов",
    "textField1""Поле ввода",
    "selectField1""Выпадающий список"
  },
  "call_center_phone_number": [
    "Номер контакт центра"
  ],
  "widget_type""Тип виджета",
  "widget_name""Название виджета",
  "widget_id""ID виджета",
  "widget_tag": ["тег1""тег2"],
  "unit_id""ID отдела",
  "unit_name""Название отдела",
  "unit_tag": ["тег1""тег2"],
  "attempt_number""Номер попытки отправки вебхука",
  "attempt_status""Статус отправки вебхука",
  "request_status""Статус заявки"
}

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

Параметр Тип Описание
attempt_id int ID попытки (вебхука)
request_created string Дата/время создания
work_mode string Режим работы (рабочее/не рабочее время)
request_id int ID заявки
client_phone int Номер телефона клиента
call_center_phone_number int Номер контакт центра
widget_type string Тип виджета
widget_name string Название виджета
widget_id int ID виджета
widget_tag string Теги виджета
unit_id int ID отдела
unit_name string Название отдела
unit_tag string Теги отдела
attempt_number int Номер попытки отправки вебхука
attempt_status string Статус отправки вебхука
request_status string Статус заявки

form_data (Данные из формы)

name string Имя 
email string Email
phone int Номер телефона 
contactUnitGroupTitle string Название группы отделов
contactUnitGroupId int ID группы отделов
note string Комментарий
textField1 string Поле ввода
selectField1 string Выпадающий список
bonus, code string Для виджета Колесо Фортуны: Название бонуса, Промокод

brand, category, color, drive, fuel, power, type, volume, weight, weightMax, wheel, year, mileage, reg_number

string/int Для виджета Трейд-ин: Бренд, Категория, Цвет, Привод, Тип топлива, Мощность двигателя, Тип кузова, Объем двигателя, Вес, Максимальный вес, Руль, Год выпуска, Пробег, Государственный номер
field.name_1 string/int Пользовательские поля

API-метод для подтверждения заявки сторонним сервисом

Запрос

POST:

https://api.calltouch.ru/widget-service/v1/api/widget-request/queue/attempt/foreign-service/approve

HTTP-заголовки:

  • Access-Token — API-ключ.

Пример тела запроса

Тело запроса в формате JSON.

Подтверждение заявки:

{
  "attemptId"232930762,
  "isPassed"true
}

Отмена заявки:

{
  "attemptId"232930762,
  "isPassed"false
}

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

Параметр    Тип    Обязательный    Описание   
attemptId  int Да ID попытки (вебхука) 
isPassed  bool  Да          ответ по заявке (true - подтверждение, false - отмена) 

После того, как система обработает заявку:

  • Если получили подтверждение, заявка уйдет на прозвон, в журнале отобразится лид. Вторая и остальные попытки, будут отработаны в штатном режиме нашей системой.
  • Если получили отказ, заявка на прозвон не уйдет, в журнале лид не отобразится. Такая заявка в очереди на прозвон будет отмечена статусом: "Отменена сторонней системой". 
  • Если мы не получим ответ от системы в течение 24 часов, то заявка будет отменена автоматически.

Пример работы

1. Пользователь на сайте заполняет форму на обратный звонок.

2. Данные из формы отправляются вебхуком в систему клиента:

{
  "attempt_id"232930762,
  "request_created""2024-11-22T16:56:19+03:00",
  "work_mode""В рабочее время",
  "request_id"222825448,
  "client_phone""79001234567",
  "form_data": {
    "name""Антон",
    "phone""79001234567",
  },
  "call_center_phone_number": [
    "74994604358"
  ],
  "widget_type""callback",
  "widget_name""Новый виджет",
  "widget_id"197851,
  "attempt_number"1,
  "attempt_status""foreign_service_check",
  "request_status""successful"
}

3. Система клиента обрабатывает вебхук и направляет запрос-подтверждения по API:

{
  "attemptId"232930762,
  "isPassed"true
}

4. После получения подтверждения, заявка уходит на прозвон и отображается в журнале звонков/лидов.


5. При получении отказа от системы, заявка на прозвон не уходит, в очереди отображается статус "Отменена сторонней системой".

Не нашли решение проблемы?
Заполните форму, и мы вам поможем.