GetTranscribationsList

Метод GetTranscribationsList

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

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

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

Авторизация

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

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

ПараметрТипОписание
date_fromstringдата начала выборки звонков в формате RFC-3339 / ISO-8601
date_tostringдата окончания выборки звонков в формате RFC-3339 / ISO-8601
limituint32лимит выводимых строк
offsetuint64номер строки, с которой начинать выборку (начинается с 0)

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

ПараметрТипОписание
urlstringURL-адрес для отправки события о готовности текстовой расшифровки звонка
uiduint64идентификатор звонка
application_uuidstringидентификатор приложения, с номера которого был совершён звонок
date_timestringдата и время готовности транскрибации RFC-3339 / ISO-8601
number_astringномер звонящего абонента
number_bstringномер принимающего абонента
redirect_numberstringномер для переадресации
durationuint32длительность разговора
chunksChunksтекстовая расшифровка разбитая на фразы участников звонка

Chunks

ПараметрТипОписание
channel_taguint64канал связи (1 — звонящий абонент, 2 — отвечающий абонент)
textstringтекст
start_timeuInt64Время начала фразы в секундах
end_timeuInt64Время конца фразы в секундах

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

КодСтатусПример сообщенияОписание
400Bad Requestinvalid value [value]в поле uid невалидный формат
401Bad Requesterror while trying to get token from headerнет заголовка авторизации
401Bad Requestfailed to parse tokenневалидный API-ключ
404Bad Requestnot found transcribation with uidнет текстовой расшифровки по этому идентификатору звонка
404Not Foundinvalid uid or application uuidневерный идентификатор звонка

Примеры

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

{
    "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
                    }
            }
        }
    ]
}