Call Transcribation API

Call Transcribation API — это программный интерфейс, который позволяет получать текстовые расшифровки разговоров. Предварительно нужно подключить услуги хранения записей разговоров и их расшифровки в текст в настройках приложения Личного кабинета. Там вы сможете выбрать подходящий срок хранения аудиозаписей — 1 месяц, 3 месяца, 6 месяцев или 1 год. Срок хранения единый для всех звонков, совершенных с/на номера и SIP ID с подключёнными услугами. В течение этого же срока будут храниться и их текстовые расшифовки.

Call Transcribation API Exolve предлагает пользователям следующие методы для работы:

• SetCallTranscribationState - включает или отключает функцию текстовой расшифровки разговора на номере;

• GetTranscribation - получает текстовую расшифровку разговора.

• GetTranscribationsList - получает список текстовых расшифровок разговоров за определённый период.

Решения, где используется Call Transcribation API

Попробовать бесплатно

Метод SetCallTranscribationState

Примените этот метод для включения и отключения функции текстовой расшифровки звонков. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/number/v1/SetCallTranscribationState

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

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

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Примечание
Чтобы включить текстовую расшифровку звонков для номера, убедитесь, что услуга уже подключена глобально в настройках приложения в Личном кабинете разработчика. Также на номере должна быть подключена услуга хранения записей разговоров. Подключить её можно в Личном кабинете в карточке номера/SIP ID или с помощью методов Call Record API.

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

Пустой JSON с 200 OK статусом.

Возможные ошибки

Примеры

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

{
    "number_code": 79991112233,
    "call_transcribation": true
}

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

{}

Метод GetTranscribation

Примените этот метод для получения текстовой расшифровки звонка. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/statistics/call-record/v1/GetTranscribation

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

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

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

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

Chunks

Возможные ошибки

Примеры

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

{
    "uid": 7143406780209569792
}

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

{
    "transcribation": [
{
    "url": "",
    "uid": "7143406780209569792",
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "date_time": "2023-12-21T01:09:10Z",
    "number_b": "74991112233",
    "calling_number": "79994445566",
    "number_a": "79997778899",
    "duration": 39,
    "call_start": "2023-12-13T14:26:44Z",
    "call_end": "2023-12-13T14:30:44Z",
    "chunks": {
        "channel_tag": "1",
            "text": "привет",
            "start_time": {
                "seconds":0
                },
            "end_time": {
                "seconds":0
                }
            }
        }
    ]
}

Метод GetTranscribationsList

Примените этот метод для получения результатов транскрибации за определенный период. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/statistics/call-record/v1/GetTranscribationsList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

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

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

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

Chunks

Возможные ошибки

Примеры

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

{
    "date_from": "2022-11-20T00:50:00Z",
    "date_to": "2024-11-22T23:50:00Z",
    "limit": 10,
    "offset": 0
}

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

{
    "transcribation": [
        {
            "url": "",
            "uid": 7122485413423484900,
            "application_uuid": "b7da867d-8c2c-4832-a924-48fbc1e7000",
            "date_time": "2023-12-13T14:25:44Z",
            "number_b": "79151234567",
            "number_a": "79151234578",
            "redirect_number": "79151234570",
            "duration": 1,
            "call_start": "2023-12-13T14:26:44Z",
            "call_end": "2023-12-13T14:30:44Z",
            "chunks": {
                "channel_tag": "1",
                "text": "привет",
                "start_time": {
                    "seconds":0
                    },
                "end_time": {
                    "seconds":0
                    }
            }
        }
    ]
}