Skip to content

Uploaded Files

List all uploaded files

This method allows you to retrieve a full list of all files uploaded to your unit.

URL

/api/v2/uploaded_files/list

Supported Parameters

  • page - the page number you wish to view (defaults to 1)

Example JSON

{
    "status": "success",
    "time": 0.01,
    "flags": {
        "paginated": {
            "page": null,
            "per_page": 30,
            "total_pages": 1,
            "total_records": 1
        }
    },
    "data": [
        {
            "id": 1,
            "name": "Queen - I Want To Break Free",
            "category": "moh",
            "created_at": "2015-08-04T13:52:31.000Z",
            "file_name": "Queen_-_I_Want_To_Break_Free.mp3",
            "extension": "mp3"
        }
    ]
}

Get uploaded file properties

This method allows you to retrieve information relating to an uploaded file in your unit.

URL

/api/v2/uploaded_files/info

Supported Parameters

  • id - the ID for an uploaded file (required)

Example JSON

{
    "status": "success",
    "time": 0.01,
    "flags": {},
    "data": {
        "id": 1,
        "name": "Queen - I Want To Break Free",
        "category": "moh",
        "created_at": "2015-08-04T13:52:31.000Z",
        "file_name": "Queen_-_I_Want_To_Break_Free.mp3",
        "extension": "mp3"
    }
}