Getting a list of media files
| Method | get.media_files |
|---|---|
| Description | Getting a list of media files |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section Paging |
offset |
number | no | Shift determines from which record number to return limit records. Default is 0. See section Paging |
filter |
object | no | See section Filtering criteria |
fields |
array | no | See section View of returned data |
sort |
array | no | See section Sorting data |
Response Options
| Name | Type | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
id |
number | Yes | Yes | Media file ID | |
name |
string | Yes | Yes | Name of the media file. Unique within one client. | |
duration |
number | Yes | Yes | Duration of the media file in seconds | |
play_link |
string | Link to listen to media file | |||
normalization |
boolean | Yes | Yes | Normalization of the media file. | |
size |
number | Yes | Yes | Media file size in bytes | |
type |
enum |
| Yes | Yes |
|
JSON request structure```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 response structure```json
{
"id": "number",
"jsonrpc": "2.0",
"result": {
"data": [
{
"id": "number",
"name": "string",
"duration": "number",
"play_link": "string",
"normalization": "boolean",
"size": "number",
"type" : "enum"
}
],
"metadata": {
}
}
}
List of returned errors
See the section "List of errors for methods with the verb get"