Перейти к содержанию

Речевая аналитика

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/project/speech/call/add?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/project/speech/call/add?key=1234567890qwerty&project=12345
    

Загрузить звонок в Речевую аналитику

POST /project/speech/call/add

Данный метод используется для загрузки звонка в инструмент Речевая аналитика.

Аудиофайл для звонка должен быть в формате MP3, WAV или OGG и доступен по ссылке.

Параметры marker и visit_id являются взаимоисключающими, т.е. необходимо указывать значение для marker, а visit_id оставлять null или наоборот.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/call/add?project=12345

Тело запроса:

{
    "date": "2019-10-09T12:00:00+0300",
    "callee": "7912345678",
    "caller": "7987654321",
    "is_outcoming": 1,
    "file_url": "http://test-domain.com/records/call.mp3",
    "operator": "Василий Петрович",
    "comment": "Это тестовый звонок в речевой аналитике",
    "fields": [
        {
            "title": "Testovoe Pole 11",
            "name": "test_field_1",
            "value": "Звонки в отдел продаж"
        },
        {
            "title": "Testovoe Pole 12",
            "name": "test_field_2",
            "value": "Звонки в отдел маркетиинга"
        },
        {
            "title": "Testovoe Pole 13",
            "name": "test_field_3",
            "value": "Звонки в техподдержку"
        }
    ]
}
{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
date string Дата и время создания записи о звонке (в формате UTC0) да
callee string Набранный номер да
caller string Номер звонящего да
file_url string Ссылка на запись звонка в формате mp3 да
operator string Оператор звонка нет
comment string Текст комментария нет
is_swapped integer Если речь оператора находится в правой дорожке аудиофайла, то устанавливать 0. Если наоборот, то 1. нет
is_outcoming integer Тип звонка: 0 - входящий звонок (передается по умолчанию), 1 - исходящий звонок. нет
order_id string ID сделки в CRM системе. По нему в Речевой Аналитике будут заполнены статус, менеджер и сумма сделки. нет
visit_id integer ID визита. По нему в Речевой Аналитике будет заполнен источник звонка. нет
marker integer Маркер рекламного канала. нет
fields array[object] Собственные параметры звонка, по которым затем можно будет фильтровать данные в истории звонков нет
title string Название параметра в истории звонков нет
name string Системное название параметра нет
value string Значение параметра нет
Параметр Тип Описание Обязательный
status string нет

Получить данные словарям Речевой аналитики

POST /project/speech/dictionary/list

Данный метод позволяет получить данные по всем словарям Речевой аналитики (пользовательским и системным).

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/dictionary/list?project=12345

Тело запроса:

Без параметров.

Пример скоро будет, смотрите возвращаемые параметры во вкладке "Параметры ответа"

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Без параметров.

Параметр Тип Описание Обязательный
id string ID словаря нет
name string Названия словаря нет
color string Цвет словаря нет
is_system boolean Словарь пользовательский, true - словарь системный нет
is_problem boolean False - непроблемный словарь, true - проблемный словарь нет
is_for_operator boolean False - словарь не применяется для речи операторов, true - словарь применяется для речи операторов нет
is_for_client boolean False - словарь не применяется для речи клиентов, true - словарь применяется для речи клиентов нет

Получить список фраз пользовательского словаря

POST /project/speech/dictionary/custom/phrase/list

Данный метод позволяет получить список фраз пользовательского словаря. В запросе необходимо передать ID нужного словаря, который можно получить из метода project/speech/dictionary/list.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/dictionary/custom/phrase/list?project=12345

Тело запроса:

{
    "id": "3"
}

Пример скоро будет, смотрите возвращаемые параметры во вкладке "Параметры ответа"

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
ID integer ID словаря да
Параметр Тип Описание Обязательный
dictionary_id integer ID словаря нет
phrases string Фразы словаря нет

Создать пользовательский словарь

POST /project/speech/dictionary/custom/create

Данный метод позволяет создать пользовательский словарь.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/dictionary/custom/create?project=12345

Тело запроса:

{
    "name": "Словарь",
    "id": null,
    "phrases": [
        "Фраза1",
        "Фраза2",
        "Фраза3"
    ],
    "is_for_client": true,
    "is_for_operator": true,
    "is_problem": true,
    "color": "#F17474"
}

Пример скоро будет, смотрите возвращаемые параметры во вкладке "Параметры ответа"

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
name string Название словаря да
is_problem boolean False - непроблемный словарь, true - проблемный словарь да
is_for_operator boolean False - словарь не применяется для речи операторов, true - словарь применяется для речи операторов да
is_for_client boolean False - словарь не применяется для речи клиентов, true - словарь применяется для речи клиентов да
color string Цвет словаря да
phrases string Фразы словаря (каждое новое слово через ввод строки) да
Параметр Тип Описание Обязательный
ID string ID словаря нет
name string Название словаря нет
color string Цвет словаря нет
is_system boolean False - словарь пользовательский, true - словарь системный нет
is_problem boolean False - непроблемный словарь, true - проблемный словарь нет
is_for_operator boolean False - словарь не применяется для речи операторов, true - словарь применяется для речи операторов нет
is_for_client boolean False - словарь не применяется для речи клиентов, true - словарь применяется для речи клиентов нет

Обновить данные по словарю

POST /project/speech/dictionary/custom/update

Данный метод позволяет обновить данные по словарю. Изменить можно любой параметр, кроме ID словаря. Чтобы получить ID словаря, используйте метод project/speech/dictionary/list.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/dictionary/custom/update?project=12345

Тело запроса:

{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
ID integer ID словаря да
name string Название словаря нет
is_problem boolean False - непроблемный словарь, true - проблемный словарь нет
is_for_operator boolean False - словарь не применяется для речи операторов, true - словарь применяется для речи операторов нет
is_for_client boolean False - словарь не применяется для речи клиентов, true - словарь применяется для речи клиентов нет
color string Цвет словаря нет
phrases string Фразы словаря нет
Параметр Тип Описание Обязательный
status string нет

Удалить пользовательский словарь

POST /project/speech/dictionary/custom/delete

Данный метод удаляет пользовательский словарь. ID словаря можно получить с помощью метода project/speech/dictionary/list.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/dictionary/custom/delete?project=12345

Тело запроса:

{
    "id": "1"
}
{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
ID integer ID словаря нет
Параметр Тип Описание Обязательный
status string нет

Получить список звонков из Речевой аналитики за определенный период

POST /project/speech/call/list

Данный метод позволяет получить список звонков из Речевой аналитики за определенный период.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/call/list?project=12345

Тело запроса:

{
    "period": {
        "from": "2019-01-14T21:00:00.000Z",
        "to": "2020-01-14T20:59:59.999Z"
    },
    "sort": [
        "date",
        "desc"
    ],
    "limit": 20,
    "offset": 0,
    "filters": [
        {
            "field": "matched_dictionaries.operator_dictionary_ids",
            "operator": "contains_all",
            "value": [
                "system_1"
            ]
        }
    ]
}

Пример скоро будет, возвращаемые параметры можно посмотреть во вкладке Параметры ответа.

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period object Временной период да
from string Начальная дата вида 2016-07-01T00:00:00+0300 да
to string Конечная дата вида 2016-07-31T00:00:00+0300 да
filters object нет
sort string нет
limit integer нет
offset integer нет
Параметр Тип Описание Обязательный
ID integer ID звонка нет
date string Дата и время создания записи о звонке (в формате UTC+0) нет
callee string Набранный номер нет
caller string Номер клиента нет
duration integer Длительность звонка (в секундах) нет
answer_duration integer Длительность ответа (в секундах) нет
waiting_time integer Длительность ожидания (в секундах) нет
link string Ссылка на звонок нет
speech_statistics object Метрики речевой аналитики нет
matched_dictionaries null или object Информация о сматченных словарях нет
client_dictionary_ids string Сматченные словари по речам клиентов нет
operator_dictionary_ids string Сматченные словари по речам операторов нет
search_phrase_start_time integer Время звонка, в котором найдена фраза (по результатам поиска) нет
is_paid boolean Звонок оплачен нет
is_analyzed boolean Звонок транскрибирован нет
operator string Оператор звонка нет
comment string Комментарий нет
order object или null Подробные данные о соответствующем заказе. Будут отображены, только если при запросе было указано "extend": ["order"]. В противном случае будет null. Подробнее о данных заказа читайте в методе /project/integration/order/list нет
visit object или null Подробные данные о визите звонка. Будут отображены, только если при запросе было указано "extend": ["visit"]. В противном случае будет null. Подробнее о данных визита читайте в методе /project/site/visit/list нет
static_source object или null Подробные данные о рекламном канале для звонка. Будут отображены, если звонки грузятся с коллтрекинга и используется статический коллтрекинг. В обратном случае будет null. нет
script_name string Сценарий коллтрекинга. Будет отображен, если звонки грузятся с коллтрекинга нет
is_outcoming integer Направление звонка. 1 - исходящий, 0 - входящий нет
status object Информация о статусе звонка (Не оплачен, В обработке, Расшифрован) нет

Получить список звонков из Речевой аналитики за определенный период в формате Excel

POST /project/speech/call/list/export/excel

Данный метод позволяет получить список звонков из Речевой аналитики за определенный период в формате Excel.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/call/list/export/excel?project=12345

Тело запроса:

{
    "period": {
        "from": "2019-10-16T21:00:00.000Z",
        "to": "2020-01-14T20:59:59.999Z"
    }
}

Без параметров.

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period object Временной период да

Без параметров.

Обновить или добавить комментарий к звонку

POST /project/speech/call/comment/update

Данный метод позволяет обновить или добавить комментарий к звонку. ID звонка можно узнать с помощью метода /project/speech/call/list.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/call/comment/update?project=12345

Тело запроса:

{
    "id": "1",
    "comment": "Новый комментарий"
}

json { "status": "success" }

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
ID integer ID звонка да
comment string Комментарий да
Параметр Тип Описание Обязательный
status string нет

Обновить или добавить оператора, принявшего звонок

POST /project/speech/call/operator/update

Данный метод позволяет обновить или добавить оператора, принявшего звонок. ID звонка можно узнать с помощью метода /project/speech/call/list.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/call/operator/update?project=12345

Тело запроса:

{
    "id": "1",
    "operator": "Максим Олегович"
}
{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
ID integer ID звонка да
operator string Имя оператора да
Параметр Тип Описание Обязательный
status string нет

Получить расшифровку звонка

POST /project/speech/call/transcription/list

Данный метод позволяет получить расшифровку звонка. ID звонка можно получить с помощью метода /project/speech/call/list.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/call/transcription/list?project=12345

Тело запроса:

{
    "call_id": 104,
    "extend": [
        "dictionary_match"
    ]
}

Пример скоро будет, возвращаемые параметры можно посмотреть на вкладке Параметры ответа.

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
callId integer ID звонка да
dictionary_match object Сматченные словари нет
Параметр Тип Описание Обязательный
ID integer ID облака с речью оператора/клиента нет
is_client boolean 0 - речь оператора, 1 - речь клиента нет
text string Текст разговора в облаке оператора/клиента нет
time integer Время звонка, на котором началась речь оператора/клиента (сек*1000) нет
dictionary_matches object Совпадения нет
ID string ID словаря нет
name string Название словаря нет
word string Фраза, по которой был сматчен словарь нет

Получить настройки Речевой аналитики

POST /project/speech/settings/list

Данный метод позволяет получить настройки инструмента Речевая аналитика.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/settings/list?project=12345

Тело запроса:

Без параметров.

Пример скоро будет, возвращаемые параметры можно посмотреть на вкладке Параметры ответа.

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Без параметров.

Параметр Тип Описание Обязательный
minimum_answer_duration integer Минимальная продолжительность длительности звонка, который может быть загружен в Речевую аналитику нет
show_transcription_from integer Длительность звонка, после которой показывается расшифровка звонка нет
is_load_calls_from_calltracking boolean True - звонки автоматически загружаются из Коллтрекинга в Речевую аналитику, false - звонки из Коллтрекинга не загружаются нет

Обновить настройки Речевой аналитики

POST /project/speech/settings/update

Данный метод позволяет обновить настройки инструмента Речевая аналитика.

Строка запроса:

POST https://cloud.roistat.com/api/v1/project/speech/settings/update?project=12345

Тело запроса:

{
    "minimum_answer_duration": 20,
    "show_transcription_from": "1",
    "is_load_calls_from_calltracking": true
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
minimum_answer_duration integer Минимальная продолжительность длительности звонка, который может быть загружен в Речевую аналитику нет
show_transcription_from integer Длительность звонка, после которой показывается расшифровка звонка нет
is_load_calls_from_calltracking boolean True - звонки автоматически загружаются из Коллтрекинга в Речевую аналитику, false - звонки из Коллтрекинга не загружаются нет
Параметр Тип Описание Обязательный
status string нет