API для экспорта

Данный API предоставляет доступ к результатам анализа звонков, выполненного системой aiokk. С его помощью вы можете экспортировать структурированные данные по звонкам в формате JSON и использовать их для интеграции, отчётности или анализа в сторонних системах (CRM, BI, Excel и др.).

Система позволяет гибко фильтровать звонки по различным признакам, включая:

  1. Отделы — фильтрация по названию конкретного подразделения или направления внутри компании.

  2. Операторы — отбор звонков по имени (ФИО) сотрудника, который обработал звонок.

  3. Тип звонка — классификация по направлению звонка:

    • Исходящий - 1

    • Входящий - 2

    • Входящие с перенаправлением - 3

    • Обратный звонок - 4

  4. Критерий оценки — звонки, в которых применялся определённый скрипт/сценарий, созданный клиентом. Фильтрация производится по ID набора вопросов.

  5. Оценка удовлетворенности клиента (1–10) — позволяет выбрать звонки, в которых аналитика дала числовую оценку удовлетворённости или лояльности клиента. Укажите значение от 1 до 10 для фильтрации.

  6. Сигналы (маяки) — наличие ключевых слов и фраз, заранее настроенных в системе (фильтрация производится по самим ключевым словам).

Методы API

1) Получить результаты анализа звонков по Отделам

POST /api/v1/export/dialogs/department

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

token

string

Токен вы можете получить в своем кабинете aiokk на страницы "Экспорт через API"

department_id

integer

ID департамента в вашей системе

Response

2) Получить результаты анализа звонков по ФИО оператора

POST /api/v1/export/dialogs/operator

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

token

string

Токен вы можете получить в своем кабинете aiokk на страницы "Экспорт через API"

operator_name

string

ФИО оператора (Иван)

Response

3) Получить результаты анализа звонков по Типу звонка

POST /api/v1/export/dialogs/call_type

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

token

string

Токен вы можете получить в своем кабинете aiokk на страницы "Экспорт через API"

call_type

integer

Исходящий - 1

Входящий - 2

Входящие с перенаправлением - 3

Обратный звонок - 4

Response

4) Получить результаты анализа звонков по ID набора Критерия оценки

POST /api/v1/export/dialogs/question_pack

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

token

string

Токен вы можете получить в своем кабинете aiokk на страницы "Экспорт через API"

qp_id

integer

ID набора критерия оценки, можно получить на странице "Критерии оценки"

Response

5) Получить результаты анализа звонков по Оценки удовлетворенности клиента

POST /api/v1/export/dialogs/client_loyalty

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

token

string

Токен вы можете получить в своем кабинете aiokk на страницы "Экспорт через API"

client_loyalty

integer

Введите любое значение от

1-10

Response

6) Получить результаты анализа звонков по Сигналам (маяки)

POST /api/v1/export/dialogs/signals

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

token

string

Токен вы можете получить в своем кабинете aiokk на страницы "Экспорт через API"

signal_word

integer

Введите любое слова из пакета маяков (Пример: дорого)

Response

Данный API предоставляет доступ к результатам анализа звонков, выполненного системой aiokk. С его помощью вы можете экспортировать структурированные данные по звонкам в формате JSON и использовать их для интеграции, отчётности или анализа в сторонних системах (CRM, BI, Excel и др.).

Система позволяет гибко фильтровать звонки по различным признакам, включая:

  1. Отделы — фильтрация по названию конкретного подразделения или направления внутри компании..

  2. Операторы — отбор звонков по имени (ФИО) сотрудника, который обработал звонок.

  3. Portal Number — фильтрация по номеру телефона, через который поступил звонок (актуально при использовании нескольких SIP-номеров).

  4. Тип звонка — классификация по направлению звонка:

    • Исходящий - 1

    • Входящий - 2

    • Входящие с перенаправлением - 3

    • Обратный звонок - 4

  5. Набор вопросов — звонки, в которых применялся определённый скрипт/сценарий, созданный клиентом. Фильтрация производится по ID набора вопросов.

  6. Оценка клиента (1–10) — позволяет выбрать звонки, в которых аналитика дала числовую оценку удовлетворённости или лояльности клиента. Укажите значение от 1 до 10 для фильтрации.

  7. Сигналы (маяки) — наличие ключевых слов и фраз, заранее настроенных в системе (фильтрация производится по самим ключевым словам).

API защищён авторизацией через токен и поддерживает фильтрацию, пагинацию, ограничение по дате

Last updated

Was this helpful?