recall_video

Recall a succesfully launched video from a site or all sites.

Explorer

Explore this method

Request URL

http://api.tubemogul.com/api/v3/

HTTP method

GET or POST

Arguments

upload_id (integer) - Required

Optional The ID of the uploaded video. This value is returned by list_uploads and upload_video.

site_id (integer) - Optional

Optional The ID of the video site to upload to. The available values are returned by list_available_sites.

Returned Status Codes

0 : Unknown Error.

1 : Successful

Example Response

<?xml version="1.0" encoding="utf-8" ?>
<response stat="ok">
<sites count="2">
  <site>
    <siteid>1</siteid>
    <status>1</status>
    <message>Succesfully scheduled for recall</videourl>
  </site>
  <site>
    <siteid>2</siteid>
    <status>105</status>
    <message>Video is not launched to video site.</message>
  </site>
</sites>
</response>

Error Codes

Standard error codes plus:

10 : uploadid is invalid or does not belong to the user

105 : video is not launched to video site

110 : we do not support recall for this site

Example Code

<?
# Your user token
$user_token = '';

# Your partner ID
$partner_id = '';

# Your secret key
$secret_key = '';

# Required upload_id
$upload_id = '';

# Optional site_id
$site_id = '';

$method = 'recall_video';

$now = time();

$apihost = 'http://www.tubemogul.com/api/v3/';

$poststring = "date=".$now.
              "&userToken=".urlencode($user_token).
              "&partnerID=".urlencode($partner_id).
              "&upload_id=".$upload_id.
              "&site_id"$site_id.
              "&method=".$method;

$hash = sha1($secret_key.$poststring);

$poststring .= "&hash=".$hash;

echo $poststring;
?>

<br /><br />
<form action='<? echo $apihost; ?>' method='post'>
<input type='hidden' name='date' value='<? echo $now; ?>' />
<input type='hidden' name='userToken' value='<? echo $user_token; ?>' />
<input type='hidden' name='partnerID' value='<? echo $partner_id; ?>' />
<input type='hidden' name='upload_id' value='<? echo $upload_id; ?>' />
<input type='hidden' name='site_id' value='<? echo $site_id; ?>' />
<input type='hidden' name='method' value='<? echo $method; ?>' />
<input type='hidden' name='hash' value='<? echo $hash; ?>' />
<input type='submit' value='submit!' />
</form>