GetList

Метод GetList

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
resource_id uint64 идентификатор ресурса аудиофайла
name string имя файла
application_uuid string идентификатор приложения, в библиотеку которого загружен аудиофайл
date_from string дата добавления аудиофайла в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_to string дата добавления аудиофайла в формате RFC-3339 / ISO-8601, до которой продолжать выборку
order_list OrderList параметры сортировки выходных данных
limit uint32 лимит выводимых строк
offset uint64 номер строки, с которой начинать выборку (начинается с 0)
file_type enum FileType тип аудиофайла

OrderList

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

OrderField

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

OrderDirection

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

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

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

GetInfo

Значение Тип Описание
file_id uint64 идентификатор аудиофайла
resource_id uint64 идентификатор ресурса аудиофайла
size uint64 размер аудиофайла в байтах
duration uint32 длительность аудиофайла в секундах
name string название файла
extension string расширение aудиофайла
description string описание аудиофайла
application_uuid string идентификатор приложения, в библиотеку которого добавлен аудиофайлл
file_type enum FileType тип аудиофайла
date_upload string дата добавления аудиофайла в формате RFC-3339 / ISO-8601
file_type enum FileMetadata метаданные аудиофайла (только для синтезированной речи)

FileType

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

FileMetadata

Параметр Тип Описание
synthesis array VoiceSettings голосовые настройки аудиофайла
text string текст синтезированной речи
VoiceSettings
Параметр Тип Описание
lang array Lang язык синтезируемой речи
voice array Voice голос для озвучивания текста
emotion array Emotion эмоция для озвучивания текста
speed float скорость синтезируемой речи (от 0.1 до 3.0, где 0.1 — самая медленная, 3.0 — самая быстрая, по умолчанию 1.0)
loudness_normalization int32 нормализация громкости (от -145 до 0, где -145 — наименьшее усиление, 0 — наибольшее усиление громкости, по умолчанию -19)

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

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

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

Код Статус Пример сообщения Описание
401 Unauthorized “error”: “failed to parse token” не указан / неправильно указан API-ключ приложения
404 Not 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 — конструктор омниканальных диалогов для бизнеса"
        }
    ]
}

Содержание статьи