users > list_uploaded_files

Tutorials, technical documents and downloads

API: Reference

Description

Get the list of files (and respective sizes) uploaded by an User.
NOTE: This functionality makes use of the User Files Index included since version 3.0.3.

Requirements

Advanced User Management extension.
WS.WebTV 3.0.3+

Required Credential Permission

GET [Signed Requests Only]

Building the Request

Request URL and GET vars

GET vars specific to this request:

Var	Value	Description
go	users	The API section
do	list_uploaded_files	The API action
iq	*User ID*	The User ID. Supply ID = 0 if you want the list of files uploaded by ALL USERS of the WebTV (WARNING: can be time consuming depending on the amount of content and number of Users).

Resulting Request URL:
The resulting request URL would be similar to this (don't forget to append the required info: key, timestamp, salt and signature):
https://....../api.php?go=users&do=list_uploaded_files&iq={user_id}&{required information}

POST vars

The following POST vars are optional.

Var	Value	Description
typeFilter	(string) *type*	Whether to filter the type of uploaded files (by the storage location). Possible values: "any" (default), "movies", "images", "gallery_images", "docs", "assorted"
includeSizes	(int) *0 \| 1*	Whether to include the size (in bytes) of the files in the list. Possible values: 0 (No, default), 1(Yes)

Response Examples

If the request was successful, you'll receive a response containing:
• list: An array with the list of files.

Example [Supplying an user ID > 0] :

{
	"list": [{
		"file_name": "my_movie.mp4",
		"size": "15284010"
	}, {
		"file_name": "clip_2536_1528796097_hq.mp4",
		"size": "1761528"
	}, {
		"file_name": "clip_2536_1528796097_normal.jpg",
		"size": "1043396"
	}, {
		"file_name": "clip_2536_1528796097_sprite.jpg",
		"size": "42534"
	}, {
		"file_name": "clip_2536_1528796097_sprite.vtt",
		"size": "851"
	}, {
		"file_name": "clip_2536_1528796098_icon.jpg",
		"size": "779"
	}, {
		"file_name": "clip_2536_1528796098_poster.jpg",
		"size": "47833"
	}, {
		"file_name": "clip_2536_1528796098_social.jpg",
		"size": "50884"
	}, {
		"file_name": "clip_2536_1528796098_thumb.mp4",
		"size": "14814"
	}]
}

If the request failed (for example, if no signature was provided in the request), you'll receive a response like the following:

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Missing signature"
}

Possible Error Messages
Besides the general errors, this request can return the following errors:

• REQUEST_ERROR | Invalid User ID:
User ID is not numeric or lower than 1.

PHP Example Code

Preparing GET and POST data.

// The GET vars
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "list_uploaded_files",
					"iq"        => 1
					);

// The POST vars
$POST_VARS = array(
					"typeFilter"	=> "any",
                    "includeSizes"	=> 1
                    );

Generating the salt, timestamp, signature and sending the request
*** The following code block is common to all signed requests ***

// Collect the API Base URL and Credential info
$API_URL = "https://www.mywebtvdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; 
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // keep this safe!!!

// Generating salt and timestamp
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));

// Generating the validation signature
// - Default method: using base64_encode(hash_hmac(...))
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comment this line if using the next method
// - Simplified method - available since v60: using md5(). 
//   This method requires the variable $API_SIGNATURE_GENERATION_MODE = 1; in the config/Config.inc.php file.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // you must "uncomment" this line when using the simplified method

// Append the timestamp, salt, key and signature to the GET vars
$GET_VARS["timestamp"] = $timestamp; 	// UTC timestamp
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ;      // The API Key ID: This is public and is used by the API to identify the application;
$GET_VARS["signature"] = $signature;

// Create the request URL. Please note that if you do not use PHP buit in function 
// to create the HTTP query then don't forget to URL encode the values
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); 
// The previous will build an URL like .../api.php?go=api_subject&do=api_action&etc...

// Create a new cURL resource and set the appropriate options
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL); 
curl_setopt($ch, CURLOPT_POST, true); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// If your PHP host does not have a valid  SSL certificate, you will need to turn off SSL
// Certificate Verification. This is dangerous (!), and should only be done temporarily
// until a valid certificate has been installed
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.

// Sending the request to the API
$response = curl_exec($ch);

// Processing the response
if (!$response) { 
	echo 'API call failed'; 
} 
else
{
	print_r(json_decode($response,true)); 
}

users > list_uploaded_files | WS.WebTV API Reference | WebTV Solutions

Professional and affordable online video solutions

API: Introduction

API: Reference

API: Reference