Выгрузка истории диалогов

В Платформе реализована возможность получения на email файла (.csv) с историей Диалогов, соответствующих условиям установленных фильтров аналитики.

Запрос и получение файла

Запрос файла с историей сообщений производится на вкладке Аналитики.

1. Установите в фильтрах Аналитики необходимые значения, как описано в статье Применимые фильтры.
2. Нажмите кнопку Chat history на панели EXPORT.
3. По нажатию кнопки появится окно с фильтрами отчета. С помощью фильтров выберите типы сообщений, информация по которым будет включена в отчет.

   1. Фильтр NLU requests отвечает за сообщения Собеседника, прошедшие через Слот NLU.

   2. Фильтр All messages and buttons отвечает за все сообщения Собеседника и Агента (в том числе сообщения Собеседника, прошедшие через Слот NLU, кнопки, отправка Attachment);

      1. При включении фильтра All messages and buttons фильтр NLU requests активируется автоматически .

      2. Фильтр NLU requests невозможно выключить, если включен фильтр All messages and buttons.

      3. После выключения фильтра All messages and buttons фильтр NLU requests становится доступен для переключения.

   3. Фильтр External requests отвечает за Внешние запросы;

   4. Фильтр Incoming Requests отвечает за Входящие запросы;

   5. Фильтр Notifications отвечает за Слоты Notification;

   6. Фильтр Timers отвечает за Слоты Timer.

4. После выставления фильтров нажмите кнопку GET REPORT. Вы получите уведомление о том, что отчет будет выслан на адрес электронной почты, на который зарегистрирован ваш аккаунт в Платформе.
5. Если в фильтрах аналитики был выбран один Агент, после выполнения запроса системой на email Аккаунт пользователя поступает письмо со ссылкой на скачивание файла. Ссылка действительна в течение 24 часов.
6. Если в фильтрах аналитики было выбрано несколько Агентов, придет несколько писем, по одному для каждого Агента.

7. Максимальный срок задержки между постановкой запроса в очередь и отправкой файла на почту составляет 24 часа.

Важно: поскольку формирование файла занимает некоторое время, в него войдут те данные, которые были в системе на момент, когда подошла очередь обработки запроса. То есть данные, имеющиеся в аналитике на момент отправки запроса и данные в файле могут отличаться.

Важно: в данный момент не реализовано ограничение на количество отправленных запросов, поэтому, при отправке повторных запросов возможны задержки в получении файлов, а также массовое поступление писем на почту.

Содержание файла

1. Файл с историей Диалогов имеет расширение .csv. Разделитель строк — запятая;

2. Кодировка файла: UTF-8;

3. Файл может быть открыт текстовыми редакторами;

4. Файл может быть открыт редакторами электронных таблиц: Google Sheets, Open Office, Pages, MS Excel. Не рекомендуется использовать MS Excel, так как в файле в одной ячейке могут быть значения с переносами строк (например, текст бота в несколько абзацев), MS Excel может некорректно обработать такие переносы, и структура таблицы будет нарушена.

Столбцы таблицы и их содержимое:

1. AGENT — имя Агента

2. CHANNEL — название Канала Агента

3. CHANNEL_ID — ID конкретного канала — объекта в Базе Данных, например, у Агента может быть два канала Telegram, у каждого свой ID

4. CHAT_ID — идентификатор Чата

5. CHAT CREATED — дата и время создания Чата, т.е. дата и время начала первого Диалога в этом Чате. Формат ЧЧ:ММ:СС ДД.ММ.ГГГГ (UTC).

6. VISITOR_ID — параметр, получаемый из Конечного канала, в котором состоялся данный Диалог

7. DIALOG_ID — идентификатор Диалога, которому принадлежит сообщение MESSAGE в данной строке

8. DIALOG STARTED — дата и время начала данного диалога. Формат ЧЧ:ММ:СС ДД.ММ.ГГГГ (UTC)

9. DIALOG DURATION — длительность данного диалога. Формат ЧЧ:ММ:СС

10. MESSAGE AUTHOR — автор сообщения MESSAGE в данной строке

    1. agent — автор сообщения — Агент

    2. user — автор сообщения — Собеседник

    3. system — сообщение Системы (когда MESSAGE TYPE timer, incoming request, external request, notification task, notification request, notification delivered, notification failed, notification no account)

11. MESSAGE TYPE — тип сообщения

    1. text — текст

    2. timer — срабатывание Timer

    3. incoming request — запуск Incoming Request

    4. button list — список кнопок Button Menu

    5. external request — отправка Внешнего запроса

    6. ER response — ответ от внешней системы на Внешний запрос

    7. attachment — отправка файла

    8. notification task — успешный запуск рассылки через слот Notification (HTTP-запрос на endpoint Chatme)

    9. notification request — приходит, если задача на запуск обработана без ошибок и система отправила запрос к API мессенджера

    10. notification delivered — приходит, если рассылка была доставлена

    11. notification failed — приходит, если аккаунта WhattsApp на указанный номер не существует

    12. notification no account — приходит, если не удалось отправить рассылку

12. MESSAGE DATE TIME — дата и время регистрации данного сообщения в базе данных Платформы. Формат ЧЧ:ММ:СС ДД.ММ.ГГГГ (UTC)

13. INTENT:

    1. intent — название распознанного Интента

    2. confidence-threshold показывает значения confidence и Threshold для обработанной Реплики. Первое число показывает значение confidence, с которым был распознан Интент. Второе число показывает значение Threshold, которое было установлено для слота NLU в момент распознавания этой Реплики.

    3. request — Реплика Собеседника
14. MESSAGE — контент сообщения, для каждого типа контента предусмотрен свой формат:

    1. “text”: неформатированный текст сообщения Агента или Собеседника. Пример:
    2. “timer”: пустая строка;

    3. "incoming request": текст со спецсловом “BODY: “, после которого следует тело запроса: BODY: {"raw_request": "{\r\n \"chat_id\": \"03313eaf4970c4de1aab4aa7afad4fa2f71c59aa\",\r\n \"is_urgent\": true,\r\n \"var1\": \"value\"\r\n}", "attributes": "{\"name\": \"name\"}", "data_type": "json"} Пример:
    4. “button list”: перечисленные через запятую по порядку вывода лейблы кнопок, взятые в кавычки. Пример:
    5. “external request”: параметры отправленного Внешнего запроса в формате: ER name: <имя Внешний запрос><тип Внешний запрос> headers: { <заголовки Внешний запрос> }body: {<тело Внешний запрос>}

    6. “ER response”: код ответа и тело полученного ответа соответственно в формате: code: <код ответа в числовом формате>body: { <тело ответа> }

    7. "attachment": тип отправленного файла и ссылка на файл в формате: type: <URL> Пример:
    8. “notification task”: запрос, который Платформа получает при запуске рассылки, и ответ на него в формате: Request: <запрос> Response: code: <код ответа> body: {<тело ответа>} Пример:
    9. “notification request”: статус рассылки, запрос который Платформа отправляет к API мессенджера (или омниканалки) для запуска рассылки и ответ на него в формате: Notification status: <статус> Request:<запрос> Response: code: <код ответа> body: {<тело ответа>} Пример:
    10. “notification delivered”: запрос, который отправляет мессенджер/омниканалка к Платформа со статусом доставки рассылки в формате: Request: <запрос> Пример:
    11. “notification failed”: запрос, который отправляет мессенджер/омниканалка к Платформа со статусом доставки рассылки в формате: Request: <запрос> Пример:
    12. “notification no account”: запрос, который отправляет мессенджер/омниканалка к Платформа со статусом доставки рассылки в формате: Request: <запрос> Пример: