GetList

Метод GetList

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

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

POST: https://api.exolve.ru/media/v1/GetList

Авторизация

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

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

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

Передайте следующие параметры в теле запроса в JSON-формате.

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

OrderList

ПараметрТипОписание
order_fieldenum OrderFieldтип сортировки выходных данных
order_directionenum OrderDirectionпорядок сортировки выходных данных

OrderField

ЗначениеТипОписание
1enumсортировка по дате добавления аудиофайла
2enumсортировка по размеру аудиофайла
3enumсортировка по продолжительности аудиофайла

OrderDirection

ЗначениеТипОписание
1enumсортировка в порядке возрастания
2enumсортировка в порядке убывания

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

ПараметрТипОписание
media_recordsarray GetInfoсписок с информацией об аудиофайлах

GetInfo

ЗначениеТипОписание
file_iduint64идентификатор аудиофайла
resource_iduint64идентификатор ресурса аудиофайла
sizeuint64размер аудиофайла в байтах
durationuint32длительность аудиофайла в секундах
namestringназвание файла
extensionstringрасширение aудиофайла
descriptionstringописание аудиофайла
application_uuidstringидентификатор приложения, в библиотеку которого добавлен аудиофайлл
file_typeenum FileTypeтип аудиофайла
date_uploadstringдата добавления аудиофайла в формате RFC-3339 / ISO-8601
file_typeenum FileMetadataметаданные аудиофайла (только для синтезированной речи)

FileType

ПараметрТипОписание
201enumаудиофайл, загруженный из локального хранилища в библиотеку приложения
202enumаудиофайл с синтезированной речью

FileMetadata

ПараметрТипОписание
synthesisarray VoiceSettingsголосовые настройки аудиофайла
textstringтекст синтезированной речи

VoiceSettings

ПараметрТипОписание
langarray Langязык синтезируемой речи
voicearray Voiceголос для озвучивания текста
emotionarray Emotionэмоция для озвучивания текста
speedfloatскорость синтезируемой речи (от 0.1 до 3.0, где 0.1 — самая медленная, 3.0 — самая быстрая, по умолчанию 1.0)
loudness_normalizationint32нормализация громкости (от -145 до 0, где -145 — наименьшее усиление, 0 — наибольшее усиление громкости, по умолчанию -19)

Нормализация применяется, чтобы выровнять громкость синтезированной речи по сравнению с «живой» речью собеседников. LUFS - это единицы измерения громкости. Этот способ измерения объединяет воспринимаемую человеческим слухом громкость и истинную интенсивность аудиосигнала

Lang

ПараметрТипЯзык
1enumрусский (по умолчанию)
2enumанглийский
3enumнемецкий
4enumиврит
5enumказахский
6enumузбекский

Voice

ПараметрТипГолосПолЭмоцияЯзык
1enumАлёна (по умолчанию)Ж1 — нейтральная (по умолчанию), 2 — добрая1 — русский
2enumЕрмилМ1 — нейтральная (по умолчанию), 2 — радостная1 — русский
3enumДжейнЖ1 — нейтральная (по умолчанию), 2 — радостная, 3 — раздраженная1 — русский
4enumОмажЖ1 — нейтральная (по умолчанию), 3 — раздраженная1 — русский
5enumЗахарМ1 — нейтральная (по умолчанию), 2 — радостная1 — русский
6enumФилиппМ—1 — русский
7enumМадирусМ—1 — русский
8enumДашаЖ1 — нейтральная (по умолчанию), 2 — радостная, 4 — дружелюбная1 — русский
9enumЮлияЖ1 — нейтральная (по умолчанию), 5 — строгая1 — русский
10enumЛераЖ1 — нейтральная (по умолчанию), 4 — дружелюбная1 — русский
11enumМаринаЖ1 — нейтральная (по умолчанию), 4 — дружелюбная, 6 — шёпот1 — русский
12enumАлександрМ1 — нейтральная (по умолчанию), 2 — радостная1 — русский
13enumКириллМ1 — нейтральная (по умолчанию), 2 — радостная, 5 — строгая1 — русский
14enumАнтонМ1 — нейтральная (по умолчанию), 2 — радостная1 — русский
15enumМашаЖ2 — радостная (по умолчанию), 4 — дружелюбная, 5 — строгая1 — русский
16enumЛеяЖ—3 — немецкий
17enumДжонМ—2 — английский
18enumНаомиЖ7 — современный, 8 — классический4 — иврит
19enumАмираЖ—5 — казахский
20enumМадиЖ—5 — казахский
21enumНигораЖ—6 — узбекский

Emotion

ПараметрТипЭмоция
1enumнейтральная
2enumрадостная
3enumраздражённая
4enumдружелюбная
5enumстрогая
6enumшёпот
7enumсовременная
8enumклассическая

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

КодСтатусПример сообщенияОписание
401Unauthorized“error”: “failed to parse token”не указан / неправильно указан API-ключ приложения
404Not Foundнекорректно введён URL запроса

Примеры

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

{
    "resource_id": "440009",
    "name": "exolve_audio",
    "application_uuid": "1fd4b297-0a04-4ca7-9ea1-6afde5da074b",
    "date_from": "2023-07-12T01:30:15.01Z",
    "date_to": "2024-12-30T01:30:15.477425Z",
    "order_list": {
        "order_direction": 2,
        "order_field": 1
    },
    "limit": 10,
    "offset": 0
}

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

{
    "media_records": [
        {
            "file_id": "1992224928825622528",
            "resource_id": "445009",
            "size": "875767",
            "duration": 22,
            "name": "exolve_audio",
            "extension": "mp3",
            "description": "",
            "application_uuid": "1fd4b297-0a04-4ca7-9ea1-6afde5da074b",
            "application_name": "exolve_application",
            "file_type": 201,
            "date_upload": "2024-11-30T10:34:43.107440Z"
             "file_metadata": {
                "synthesis": {
                   "lang": 1,
                   "voice": 1,
                   "emotion": 1,
                   "speed": 1,
                   "loudness_normalization": -19
              },
                 "text": "МТС Exolve — конструктор омниканальных диалогов для бизнеса"
        }
    ]
}