GetInfo

Метод GetInfo

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

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

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

Авторизация

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

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

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

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

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

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

ПараметрТипОписание
media_recordsarrayсписок с информацией об аудиофайлах
file_iduint64внутренний ID аудиофайла
resource_iduint64уникальный идентификатор загруженного аудиофайла
sizeuint64размер аудиофайла в байтах
durationuint32длительность аудиофайла в секундах
namestringимя файла
extensionstringрасширение aудиофайла
descriptionstringописание к аудиофайлу
application_uuidstringуникальный идентификатор приложения, к которому загружен аудиофайл
file_typeenum FileTypeтип аудиофайла
date_uploadstringдата загрузки аудиофайла в формате RFC-3339 / ISO-8601
file_metadataenum 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классическая

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

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