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)

OrderList

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

OrderField

Значение ID Описание
ORDER_FIELD_UNSPECIFIED 0 тип сортировки не определен
ORDER_FIELD_DATE 1 сортировка по дате загрузки аудиофайла
ORDER_FIELD_SIZE 2 сортировка по размеру аудиофайла
ORDER_FIELD_DURATION 3 сортировка по продолжительности аудиофайла

OrderDirection

Значение ID Описание
ORDER_DIRECTION_UNSPECIFIED 0 тип сортировки не определен
ORDER_DIRECTION_ASC 1 сортировка в порядке возрастания
ORDER_DIRECTION_DESC 2 сортировка в порядке убывания

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

Параметр Тип Описание
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

FileType

Значение ID Описание
FILE_TYPE_IVR 200 IVR (интерактивное голосовое меню)
FILE_TYPE_PREMEDIA 201 премедиа (аудиосообщение, которое воспроизводится клиенту до ответа оператора)

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

Код Статус Пример сообщения Описание
401 Unauthorized malformed token не указан / не правильно указан API-ключ приложения

Примеры

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

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

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