Медиафайлы
Получение списка медиафайлов
| Метод | get.media_files |
|---|---|
| Описание | Получение списка медиафайлов |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел Постраничный вывод |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать limit записей. По умолчанию 0. См. раздел Постраничный вывод
|
filter |
object | нет | См. раздел Критерии фильтрации |
fields |
array | нет | См. раздел Представление возвращаемых данных |
sort |
array | нет | См. раздел Сортировка данных |
Параметры Ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|---|
id |
number | Да | Да | ID медиафайла | |
name |
string | Да | Да | Название медиафайла. Уникально в рамках одного клиента. | |
duration |
number | Да | Да | Длительность медиафайла в секундах | |
play_link |
string | Ссылка для прослушивания медиафайла | |||
normalization |
boolean | Да | Да | Нормализация медиафайла. | |
size |
number | Да | Да | Размер медиафайла в байтах | |
type |
enum |
|
Да | Да |
|
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.media_files",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"id": "number",
"jsonrpc": "2.0",
"result": {
"data": [
{
"id": "number",
"name": "string",
"duration": "number",
"play_link": "string",
"normalization": "boolean",
"size": "number",
"type" : "enum"
}
],
"metadata": {
}
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"