Email Media

From KickApps Documentation

Emails an invitation containing a link to view a media play page. A given username can send up to 20 emails in a 24-hour period. In your request, separate multiple addresses or usernames by commas. You can make an HTTP POST or GET request for this call.

Important. A member of a given affiliate site can send up to 20 emails per day. If this is not sufficient for you members' needs, please contact KickApps.

Your request will look something like the following:

http://api.kickapps.com/rest/email/{mediaType}/{mediaId}/{as}

Contents 1 Parameters 2 Post Parameters 3 Example Requests 3.1 Java 3.2 C# 3.3 PHP 4 JSON Payload 5 List of KickApps API Calls

Parameters

As shown above, your call will include the following parameters:

• mediaType. The media type. audio, photo, blog, sets or video. KickApps' sample applications use mediaType to check for the Flash player to use.
• mediaId. The id of the media that is being emailed. This is specific to both the as and the media type.
• as. The site to be sent. as is unique for each of the affiliate's sites.

Post Parameters

• t. String. Required. Your access permissions.
• callback. String. Optional. The name of your JavaScript callback function.
• clientIP. String. Optional. Use the clientIP parameter to pass the IP address of the user making the call. If the IP has been blocked by the webmaster under the Affiliate Center -> Manage Members section, an error message will be returned starting with "status":"-1","error":"This IP address has been banned".
• friends. The recipient’s email address or KickApps username. Separate multiple addresses or usernames by commas.
• fromName. The name of the sender.
• mediaName. The media item's title.
• customMessage. A message of between 0 and 5,000 characters in length.

Example Requests

The following requests show an application's call to the REST API, see the relevant sample application code for more details. In the examples, "friends" is a comma-separated list of email addresses.

Java

NameValuePair[] tokenParams = {new NameValuePair("t", ka_token.getToken()),
new NameValuePair("customMessage", customMessage),
new NameValuePair("fromName", fromName),
new NameValuePair("friends", friends),
new NameValuePair("mediaName", mediaName) };
if (fromName != null) {
if (ka_token != null) {

System.out.println(KickAppsHttpClient.EMAIL_PAGE_URL
+ mediaType + "/" + mediaId + "/" + as);
JSONObject playPageObject = KickAppsHttpClient.doRestCall(KickAppsHttpClient.EMAIL_PAGE_URL
+ mediaType + "/" + mediaId + "/" + as,
"POST", tokenParams);

C#

The C# sample app uses af as the value for as (affiliate site id).

objclsRestClient = new clsRestClient();
RestUrl = clsRestClient.EMAIL_PAGE_URL +    mediaType + "/" + mediaId + "/" + af;

NameValueCollection parameters = new NameValueCollection();
parameters.Add("t", objToken.TOKEN);
parameters.Add("customMessage", customMessage);
parameters.Add("fromName", fromName);
parameters.Add("friends", friends);
parameters.Add("mediaName", mediaName);

result = objclsRestClient.doRestCall(RestUrl, "POST", parameters);
objToken.PAYLOAD = result;

PHP

$ka_token=$_SESSION['token'];

if ($ka_token == "" || $ka_token->getToken() == "") {
	//Since token is null member is not logged in send them back
	redirect(dirname($_SERVER['PHP_SELF'])."/login.php");
}
		
$as = $ka_token->getAs();
$customMessage = $_REQUEST['customMessage'];
$fromName = $_REQUEST['fromName'];
$friends = $_REQUEST['friends'];
$mediaName = $_REQUEST['mediaName'];
$mediaType = $_REQUEST['mediaType'];
$mediaId = $_REQUEST['mediaId'];

						
$rest_url = EMAIL_PAGE_URL . $mediaType ."/".$mediaId."/".$as;

$ch = curl_init($rest_url);
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, 't='.$ka_token->getToken().'&customMessage='.$customMessage.'&fromName='.$fromName.'&friends='.$friends.'&mediaName='.$mediaName);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
if ($fromName != "") {
	if ($ka_token != "") {
		$buf=curl_exec ($ch);

		curl_close ($ch);	

JSON Payload

On success, a payload that begins with "status":"1","error":"".

List of KickApps API Calls

API Change Log Create Token Call Social Networking Retrieve Member Profile Add Or Remove Member As Friend Get A Member's Friends, Fans, and "Fan Of" Retrieve User by Facebook Id KickConnect Assign Member Profile Photo Remove Member Profile Photo Member Profile Edit/Update SSO Method Member Register SSO Method Combined Member Sign On and Register SSO Method Member Change Username SSO Method Member Change Email SSO Method OpenAuth Create Message Board Media Sharing Upload Media Retrieve Media Meta Data Edit Media Meta Data Delete Member Media Retrieve Play Page Retrieve Member Media Retrieve Member's Favorite Media Retrieve Related Media Member Favorite Media Check Email Media Add Or Remove Media Flag Add To Or Remove From Favorites Geographic Values for Media Uploads Get Video Thumbnails Set Video Thumbnail Blogging Add Blog Post Edit Blog Post Comments and Rating Add External Media Retrieve External Media Edit External Media Add Group Comment Add Media Comment Add Profile Comment Retrieve Comments Search Comments Edit Comment Edit Group Comment Delete Comment Delete Group Comment Flag Comment Flag Group Comment Rate Media Retrieve Media Ratings Retrieve Media Rated By Member Retrieve Likes By User ID Search Search Media Sets Add Media Set Edit Set Retrieve Set Delete Set Add Media to Set Remove Media from Set Groups Add Group Retrieve Group Page Edit Group Request A Group Add/Remove Media To Group Add/Remove Member To Group Retrieve Member Groups Upload Group Photo Remove Group Photo Polls Creating Polls Using the Tag API’s

Contests Add Contest Edit Contest View Contest Retrieve All Contests Add Contest Entry Edit Contest Entry Remove Contest Entry View Contest Entry Retrieve Entries for Contest Select Contest Winner Flag Contest Entry Points and Levels Add to Member Offset Retrieve Member Points Set Member Custom Level Set Member Offset Badges Add Badge Edit Badge List Badges Add Action List Actions Add Badge Requirement Edit Badge Requirement List Badge Requirements Add User Action Retrieve User's Badges Retrieve User's Badge Status Retrieve Super Fans Get Super Fan Ranking Set Super Fan Badge Criteria Categories and Tags Add Tags To Media, Members and Groups Remove Tags From Media, Members and Groups Add Admin Tags To Media, Members and Groups Remove Admin Tags From Media, Members and Groups Retrieve Admin Tags Retrieve Tag Count Add Category Edit Category Retrieve Category Delete Category Add Custom Meta Data Remove Custom Meta Data Retrieve Custom Meta Data Member and Media Management Approve Member Reject Member Approve Member Media Reject Member Media Delete Member Media Retrieve Pending Media Retrieve Active Member Count Retrieve Site Settings CRM Connectors KickApps SugarCRM Connector KickApps Salesforce Connector CRM Connectors (COMING SOON!!) IBM Websphere Microsoft Dynamic CRM NetSuite Oracle CRM On Demand Oracle E-Business Suite CRM PeopleSoft Enterprise CRM Oracle Siebel CRM SAP CRM Sugar Professional Maximizer CRM Pegasystems Customer Process Manager

Note: Occasionally (and without advanced warning) we modify our API calls by adding new parameters in the response payload. Please keep this in mind when designing your strategy for parsing our responses.