Речевая аналитика
Описание
В IQChannels можно собирать аналитику диалогов для дальнешей обработки.
Настройка IQChannels
⦁ Проекты – Проект – Внешние системы – Вкладка «Аналитика диалогов»
⦁ Нажмите кнопку «Создать»
В открывшемся окне необходимо настроить точку входа:
Тип задан по умолчанию – Речевая аналитика БСС. Название заполняем по своему усмотрению.
Лимит кол-ва диалогов –ограничение, если запросить большое количество диалогов сразу, это может сказаться на производительности и времени формирования ответа!
Требуется аутентификация – ставим галку, чтобы задать токен доступа. Если не требуется – галку не ставим. Токен – жмем кнопку «Сгенерировать», чтобы сгенерировать новый токен доступа.
⦁ После нажатия на кнопку «Добавить», отобразится сгенерированный системой эндпоинт для подключения:
Используйте URL для запросов чтобы настроить подключение на стороне речевой аналитики.
Запрос
Все запросы отправляются с помощью HTTP POST запросов к REST-сервису на сгенерированный в настройках эндпоинт.
Пример запроса
[https://[host]/public/api/analytics/030e9e08-62b1-4814-b5a9-52eeeeff6f97](https://iqchannels.isimplelab.com/public/api/analytics/030e9e08-62b1-4814-b5a9-52eeeeff6f97)
Параметры POST запроса
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| start_date | String | да | С какой даты нужно собирать данные по диалогам. Фильтр по дате создания сообщений в диалоге. Дата должна быть в формате YYYY-DD-MM. |
| end_date | String | нет | Если не указано, то будут выгружены диалоги только за день, указнный в start_date и end_date. |
| full_dialog | Bool | нет | True - если сообщения из диалога попало в интервал start_date и end_date - будет выгружен весь диалог со всеми сообщениями. False - будут выгружены только те сообщения и диалоги, которые попадают в интервал start_date и end_date. |
Ответ
Response
В случае успешного ответа сервер возвращает статус 200 с ответом в формате application/json.
| Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
dialogs | Массив объектов типа Dialog | да |
Описание объекта Dialog
| Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
| _id | string | Да | |
| session_id | string | Да | |
| custom.status | string | Да | Статус взаимодействия END, WAIT |
| start_date | string(datetime) | Да | Дата начала периода |
| end_date | string(datetime) | Нет | Конец периода |
| channel | string | Нет | Тип канала |
| adapter | string | Нет | Константа “iqstore” |
| custom.themes | string | Нет | Категория обращения |
| custom.client_crm_id | string | Нет | Идентификатор клиента в ДБО |
| custom.client_abs_id | string | Нет | Идентификатор клиента в АБС |
| custom.client_login | string | Нет | Логин клиента |
| custom.client_iqchannels_id | integer | Нет | Идентификатор клиента в IQChannels |
| interactions | массив объектов типа Interaction | Да | Описание смотрите ниже |
Описание объекта Interaction
| Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
| role | string | Да | Роль: Для клиента константа «user». Для оператора – роль оператора в системе. |
| datetime | string/datetime | Да | Дата сообщения |
| content | string или json | Да | Текст сообщения |
| content_type | string | Нет | Тип сообщения |
| type | string | Да | Константа «UTTERANCE» |
| source | string | Нет | |
| operator_data | Object | Нет |
Описание объекта Operator_data
| Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
| group | string | Да | Группа оператора |
| group_name | string | Нет | Название группы |
| operator | string | Нет | Адрес электронной почты оператора |
| operator_name | string | Да | Имя оператора |
Пример ответа в формате JSON:
{
"dialogs": [
{
"_id": "1",
"session_id": "1",
"custom.status": "END",
"start_date": "2024-08-05T19:22:34.987115+03:00",
"end_date": "2024-08-05T19:26:44.210458+03:00",
"channel": "support",
"adapter": "iqstore",
"custom.themes": "",
"interactions": [
{
"role": "user",
"datetime": "2024-08-05T19:22:34.999311+03:00",
"content": "da",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "system",
"datetime": "2024-08-05T19:22:37.574683+03:00",
"content": "",
"type": "TRANSFER",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:22:37.575187+03:00",
"content": {
"group": "Операторы",
"operator_name": "Bttt"
},
"type": "OPERATOR_DATA",
"content_type": "application/json",
"source": "",
"attributes": null
},
{
"role": "bot",
"datetime": "2024-08-05T19:22:52.529517+03:00",
"content": "Был отправлен файл",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:22:52.546126+03:00",
"content": "Я IQBot - ваш персональный ассистент!",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:22:52.566056+03:00",
"content": "Выберите нужное действие или напишите мне запрос, а я попробую вам помочь😉",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "user",
"datetime": "2024-08-05T19:23:06.801229+03:00",
"content": "Узнать об IQBot",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:23:08.855849+03:00",
"content": "Я IQBot - ваш интерактивный ассистент! Я помогу вам получить необходимую информацию в вашем любимом месенджере.",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:23:08.876037+03:00",
"content": "Могу ответить на ваши вопросы, спросите меня о чем-нибудь! Например \"IQ, какой график в компании?\"",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:23:08.902515+03:00",
"content": "Чтобы вернуться в предыдущее меню нажмите \"Назад\"",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "user",
"datetime": "2024-08-05T19:23:12.089416+03:00",
"content": "Назад",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:23:13.812628+03:00",
"content": "Выберите нужное действие или напишите мне запрос, а я попробую вам помочь😉",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "system",
"datetime": "2024-08-05T19:25:51.157231+03:00",
"content": "",
"type": "TRANSFER",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "operator",
"datetime": "2024-08-05T19:25:51.158094+03:00",
"content": {
"group": "Операторы",
"operator": "sunriderr37@gmail.com",
"operator_name": "Test"
},
"type": "OPERATOR_DATA",
"content_type": "application/json",
"source": "",
"attributes": null
},
{
"role": "",
"datetime": "2024-08-05T19:26:44.202483+03:00",
"content": "Было отправлено сообщение с оценкой оператора",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "system",
"datetime": "2024-08-05T19:26:44.211665+03:00",
"content": "",
"type": "HANGUP",
"content_type": "text/plain",
"source": "external",
"attributes": {}
}
]
},
{
"_id": "2",
"session_id": "2",
"custom.status": "END",
"start_date": "2024-08-05T19:26:51.016657+03:00",
"end_date": "2024-08-05T19:27:28.526806+03:00",
"channel": "support",
"adapter": "iqstore",
"custom.themes": "",
"interactions": [
{
"role": "user",
"datetime": "2024-08-05T19:26:51.02288+03:00",
"content": "вв",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "system",
"datetime": "2024-08-05T19:26:51.56121+03:00",
"content": "",
"type": "TRANSFER",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:26:51.562492+03:00",
"content": {
"group": "Операторы",
"operator_name": "Bttt"
},
"type": "OPERATOR_DATA",
"content_type": "application/json",
"source": "",
"attributes": null
},
{
"role": "bot",
"datetime": "2024-08-05T19:27:08.841513+03:00",
"content": "Был отправлен файл",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:27:08.866563+03:00",
"content": "Я IQBot - ваш персональный ассистент!",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:27:08.898684+03:00",
"content": "Выберите нужное действие или напишите мне запрос, а я попробую вам помочь😉",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "user",
"datetime": "2024-08-05T19:27:15.897092+03:00",
"content": "Запросить демонстрацию",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "bot",
"datetime": "2024-08-05T19:27:17.46718+03:00",
"content": "Переключаю вас на менеджера по работе с клиентами",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "",
"datetime": "2024-08-05T19:27:28.517518+03:00",
"content": "Было отправлено сообщение с оценкой оператора",
"type": "UTTERANCE",
"content_type": "text/plain",
"source": "external",
"attributes": {}
},
{
"role": "system",
"datetime": "2024-08-05T19:27:28.528558+03:00",
"content": "",
"type": "HANGUP",
"content_type": "text/plain",
"source": "external",
"attributes": {}
}
]
}
]
}