GetInfo

Метод GetInfo

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
resource_ids Array of uint64 уникальные идентификаторы загруженных аудиофайлов

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

Параметр Тип Описание
media_records array список с информацией об аудиофайлах
file_id uint64 внутренний ID аудиофайла
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_metadata 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 классическая

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

Код Статус Пример сообщения Описание
400 Bad Request “error”: “proto: (line 3:7): invalid value for uint64 type: ""” не задано значение поля resource_ids
400 Bad Request “error”: “invalid GetInfoRequest.ResourceIds[0]: value must be greater than 0” значение поля resource_ids должно быть больше 0
400 Bad Request “error”: “invalid GetInfoRequest.ResourceIds: value must contain at least 1 item(s)” поле resource_ids должно содержать хотя бы 1 символ
400 Bad Request “error”: “proto: (line 3:7): invalid value for uint64 type: "qwe"” невалидное значение поля resource_ids
401 Unauthorized “error”: “failed to parse token” не указан / неправильно указан API-ключ приложения
404 Not Found некорректно введён URL запроса

Примеры

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

{
   "mediaRecords": [
       {
           "fileId": "1862848703375831040",
           "resourceId": "6266",
           "size": "25747",
           "duration": 1,
           "name": "exolve_audio.mp3",
           "extension": "mp3",
           "description": "uploaded audio",
           "applicationUuid": "0356dc59-deeb-4546-b314-fbc31bd778fc",
           "applicationName": "exolve_application",
           "fileType": 201,
           "dateUpload": "2024-12-08T10:07:52.010849Z"
           "file_metadata": {
               "synthesis": {
                  "lang": 1,
                  "voice": 1,
                  "emotion": 1,
                  "speed": 1,
                  "loudness_normalization": -19
             },
                "text": "МТС Exolve — конструктор омниканальных диалогов для бизнеса"
   }
       }
   ]
}

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

{
   "media_records": [
       {
           "file_id": "1885716233567862784",
           "resource_id": "138517",
           "size": "26375",
           "duration": 3,
           "name": "Test audio",
           "extension": "mp3",
           "description": "Тестовый аудиофайл",
           "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
           "application_name": "Test",
           "file_type": 201,
           "date_upload": "2023-02-09T13:03:04.996514Z"
       },
       {
           "file_id": "1931072746905665536",
           "resource_id": "152817",
           "size": "121087",
           "duration": 5,
           "name": "test5",
           "extension": "mp3",
           "description": "",
           "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
           "application_name": "Test",
           "file_type": 201,
           "date_upload": "2023-06-14T16:53:40.459735Z"
       }
   ]
}

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