Media API

Media API — программный интерфейс, который позволяет пользователям управлять аудиофайлами в Личном кабинете: загружать, удалять, скачивать и т.д. Файлы используются для проигрывания аудиосообщений абонентам во время звонков.

Media API Exolve предлагает пользователям следующие методы для управления аудиофайлами:

• Upload - загружает аудиофайл в Личный кабинет;

• GetList - получает информацию обо всех загруженных в Личный кабинет аудиофайлах, соответствующих определённым параметрам;

• GetInfo - получает информацию об указанных в запросе аудиофайлах;

• Download - получает указанный в запросе аудиофайл;

• Update - изменяет название и описание загруженного аудиофайла в Личном кабинете;

• Delete - удаляет аудиофайл из Личного кабинета.

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

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

Метод Upload

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

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

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

Авторизация

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

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

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

Примечание

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

FileType

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

FileType

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

Примеры

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

{
    "file": "SUQzAwAAAAAfdlRZRVIAAAAFAAAAMjAyMVRJVDIAAABHAAAB//4TBDgEQgQwBEAEMAQgADwENQQ7BD4ENAQ4BE8EIABABD4EO",
    "file_type": "FILE_TYPE_PREMEDIA",
    "full_name": "test.mp3"
}

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

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

Метод GetList

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

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

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

Авторизация

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

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

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

OrderList

OrderField

OrderDirection

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

FileType

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

Примеры

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

{
     
   "date_from": "2022-12-12T01:30:15.01Z",
    "date_to": "2024-01-15T01:30:15.477425Z",
    "order_list": {
        "order_direction": 1,
        "order_field": "ORDER_FIELD_DATE"
    },
    "limit": 2,
    "offset": "0"
}

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

{
    "media_records": [
        {
            "file_id": "1931072746905665536",
            "resource_id": "152817",
            "size": "121087",
            "duration": 5,
            "name": "Test1",
            "extension": "mp3",
            "description": "",
            "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
            "application_name": "Test",
            "file_type": 201,
            "date_upload": "2023-06-14T16:53:40.459735Z"
        },
        {
            "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"
        }
    ]
}

Метод GetInfo

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

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

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

Авторизация

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

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

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

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

FileType

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

Примеры

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

{
    "resource_ids": [
        "138517",
        "152817"
    ]
}

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

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

Примените этот метод для получения загруженного файла по идентификатору ресурса. Для этого выполните 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

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

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

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

Авторизация

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

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

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

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

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

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

Примеры

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

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

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

{}

Метод Delete

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

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

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

Авторизация

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

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

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

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

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

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

Примеры

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

{
    "resource_ids": [
        "138231"
    ]
}

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

{}