Media API

Media API позволяет управлять аудиофайлами, загруженными в библиотеку приложения, и синтезированной речью. Эти аудио можно использовать для проигрывания аудиосообщений абонентам при переадресации входящего вызова, исходящем автодозвоне и callback.

Методы Media API Exolve для управления аудиофайлами:

• Upload — загружает аудиофайл в Личный кабинет;
• Synthesize — синтезирует речь согласно заданным параметрам без добавления сфомированного файла в библиотеку приложения;
• SynthesizeAndSave — синтезирует речь согласно заданным параметрам с последующим добавлением сфомированного файла в библиотеку приложения;
• GetList — получает информацию обо всех добавленных в библиотеку приложения аудиофайлах, соответствующих заданным параметрам;
• GetInfo — получает информацию об аудиофайле;
• Download — скачивает аудиофайл;
• Update — изменяет атрибуты добавленного в библиотеку приложения аудиофайла;
• Delete — удаляет аудиофайл из библиотеки приложения.

Решения, где используется Media API

Кол-трекинг

Обратный звонок

Переадресация вызовов

Попробовать бесплатно

Метод Upload

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

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

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

Авторизация

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

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

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

Примечание

Загружаемый аудиофайл не должен превышать размер в 5MB и название файла должно быть в формате MP3 или WAV.

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

FileType

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

Примеры

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

{
   "file": "SUQzAwAAAAAfdlRZRVIAAAAFAAAAMjAyMVRJVDIAAABHAAAB//4TBDgEQgQwBEAEMAQgADwENQQ7BD4ENAQ4BE8EIABABD4EO",
   "file_type": 201,
   "full_name": "exolve_audio.mp3"
}

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

{
   "file_id": "1931072746905665536",
   "resource_id": "152817",
   "size": "121087",
   "duration": 5,
   "name": "exolve_audio",
   "extension": "mp3",
   "description": "uploaded audio",
   "application_uuid": "178ec145-6848-4b06-a92a-75f63cb57046",
   "file_type": 201,
   "date_upload": "2023-06-14T16:53:40.459734572Z"
}

Метод GetList

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

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

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

Авторизация

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

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

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

OrderList

OrderField

OrderDirection

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

GetInfo

FileType

FileMetadata

VoiceSettings

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

Lang

Voice

Emotion

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

Примеры

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

{
    "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 — конструктор омниканальных диалогов для бизнеса"
        }
    ]
}

Метод GetInfo

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

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

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

Авторизация

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

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

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

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

FileType

FileMetadata

VoiceSettings

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

Lang

Voice

Emotion

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

Примеры

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

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

Метод Download

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

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

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

Авторизация

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

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

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

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

FileType

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

Примеры

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

{
    "resource_id": "6088"
}

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

{
    "file": "SUQzAwAAAAAfdlRZRVIAAAAFAAAAMjAyMVRJVDIAAABHAAAB//4TB",
    "full_name": "19999tgb.mp3",
    "resource_id": "6088",
    "file_type": 201
}

Метод Update

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

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

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

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом

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

Примеры

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

{
    "resource_id": "152817",
    "name": "Update Test",
    "description": "Тест обновления аудиофайла"  
}

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

{}

Метод Delete

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

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

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

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "resource_ids": [
        "138231"
    ]
}

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

{}