Подписаться

Передача данных во внешние системы: Webhook

Содержание

1. Принцип работы

На стороне LiveTex реализован webhook, предоставляющий внешним клиентским сервисам данные о завершённом обращении.

Обратите внимание, что данная функциональность работает только на тарифе "Продвинутый". Подключить его поможет ваш персональный менеджер LiveTex

В личном кабинете LiveTex (https://my.livetex.ru/products/integrations) можно указать URL адрес, на который будут отправляться данные в формате JSON каждый раз, когда сотрудник будет закрывать обращение в приложении оператора. 

Webhook — механизм получения уведомлений об определённых событиях LiveTex в свою собственную систему. Webhook на стороне LiveTex позволяет получать уведомления о каждом событии закрытия диалога оператором. Таким образом, используя webhook, LiveTex предоставляет возможность осуществить интеграцию с внешними системами, в том числе с CRM.

В системе LiveTex такая возможность реализована следующим образом. 

2. JSON

Выходные параметры

Название Тип Обязательность Описание
Conversation Conversation + Обращение
discourser Discourser + Собеседник
employee Array + Список сотрудников, участвовавших в обращении


Conversation

Название Тип Обязательность Описание
category string + Тип обращения (тех. поддержка, консультация по продаже и т.д.)
creationTime datetime + Время создания обращения
closedTime datetime + Время закрытия обращения
messages Array<Message> + Сообщения в обращении
discourserRate string - Оценка собеседником
customInfo Array<CustomInfo> - Пречат поля
communicationType Enum + Канал

communicationType
Ключ Значение
1 Чат на сайте
2 Офлайн-заявка
3 Заказ звонка
4 Мобильное приложение
5 Email
6 Facebook
7 Telegram
8 ВКонтакте
9 Viber
10 WhatsApp
11 Одноклассники
12 Messaging API
13 Яндекс.Диалоги

Message
Название Тип Обязательность Описание
creation_Time dateTime + Время создания сообщения
employee_id string + Идентификатор сотрудника, отправившего сообщение, если «NULL», то отправитель - собеседник
Content string + Текст сообщения
sender_type SenderType + Тип отправителя

SenderType
Ключ Значение Описание
EMPLOYEE “employee” Сотрудник
DISCOURSER ”discourser” Собеседник

CustomInfo
Название Тип Обязательность Описание
Name string + Наименование поля
Value string + Значение поля

Discuorser
Название Тип Обязательность Описание
Name string - Имя собеседника.
City string - Город, из которого написал собеседник. Определяется по GeoIP.
Country string - Страна, из которой написал собеседник. Определяется по GeoIP.
contactData Array<ContactData> - Контактная информация

ContactData
Название Тип Обязательность Описание
Value string + Значение контакта
Contact_date_type ContactDataType + Тип контакта (email или телефон)

ContactDataType
Ключ Значение Описание
EMAIL “email” email
PHONE ”phone” Телефон

Employee
Название Тип Обязательность Описание
Id String + Уникальный (в рамках LiveTex) идентификатор сотрудника
firstName String + Имя сотрудника
middleName String + Отчество сотрудника
lastName String + Фамилия сотрудника
Group Array<Group> + Группа сотрудника, в рамках которой велось Обращение

Group
Название Тип Обязательность Описание
Id String + Уникальный (в рамках LiveTex) идентификатор группы
Title String + Название группы

 

3. Пример данных

{
  "conversation": {
    "category": "все",
    "creationTime": "2016-07-04T12:06:54",
    "closedTime": "2016-07-04T12:07:04.867050",
    "messages": [{
      "creation_time": "2016-07-04T12:06:54",
      "employee_id": "1",
      "content": "Один заказ отменяем?",
      "sender_type": "discourser"
    }, {
      "creation_time": "2016-07-04T12:06:58",
      "employee_id": "22405",
      "content": "Да",
      "sender_type": "employee"
    }, {
      "creation_time": "2016-07-04T12:07:03",
      "employee_id": "1",
      "content": "Какой оформляем?",
      "sender_type": "discourser"
    }],
    "customInfo": [{
      "name": "VIP клиент",
      "value": "второй"
    }, {
      "name": "Артикул товара:",
      "value": "QW123456"
    }, {
      "name": "client_id",
      "value": "12345"
    }],
    "communicationType": 1
  },
  "discourser": {
    "name": "Гость",
    "city": "Saint Petersburg",
    "country": " Russian Federation ",
    "contactData": []
  },
  "employee": [{
    "id": "22405",
    "firstName": "Ivan",
    "middleName": "Olegovich",
    "lastName": " Ivanov ",
    "group": [{
      "id": "16535",
      "title": ""
    }, {
      "id": "16758",
      "title": ""
    }]
  }]
}
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0
Еще есть вопросы? Отправить запрос

Комментарии