API.fetchSubscriptionSubscribers

This action allows you to recover all or part of the subscribers from a subscription on your account.

Request

api_key Use your API key
login Use the e-mail address of an account profile that has access to the APIs.
md5_pwd Use the password from the profile, encrypted in MD5 format.
subscription_code Use the API code supplied in the “Your subcriptions” page, or recovered by the getAccountSubscriptions API
order (optional)
String of characters used to define the organization criteria of the subscribers. The possible values are:
  • FirstName: First name of the subscriber
  • LastName: Last name of the subscriber
  • Login: Login of the subscriber
  • LastLogin: Date of last login
  • Creation: Date the subscriber was created
  • Modification: Date the subscriber was edited
way (optional) Sort by descending order
  • UP : Sort by ascending order
  • DOWN : Sort by descending order
start (optional) Start position of the range of subscribers sent.
step (optional) Number of subscribers to be sent from the start position.

Response

This request sends a table containing the requested subscribers with the following information:

LastName Last name of the subscriber.
FirstName First name of the subscriber.
Email Email address of the subscriber.
Login Login of the subscriber.
Password Password of the subscriber.
IsActive Status of the subscriber: 1 if he/she is activated, 0 if not.
Extras Additional information on the subscriber, in varchar format up to 255 characters in size
LastLogin Date of last login.
Creation Date the subscriber was created.
Modification Date the subscriber was last edited.

 

An error message is sent back in case of problems.

Example

This example shows how to recover the last 10 subscribers of a subscription:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>My most recent subscribers</title>
</head>
<body>
<?php
    include_once('nusoap.php');
   
    $client = new soapclient('http://api.calameo.com/?wsdl', true);

    $err = $client->getError();
 
    if ($err) {
       // Display the errors
       echo 'SOAP Error: ' . $err;
       // If an error occurs, it\’s useless to continue
       die('An error has occurred!');
    }
    $message = 'API.fetchSubscriptionSubscribers';
    $params = array (
      'api_key'  => '123346544abdefbca1546854',
      'login'  => 'email@myaccount.com',
      'md5_pwd'  => 'd4f7ccab36fbfedc5f53e09d20d6973a',
      'subscription_code' => '05511df55155d5a5bc5',
      'order'  => 'Creation',
      'way'  => 'DOWN',
      'start'  => 0,
      'step'  => 10
      );
    $result = $client->call($message, $params);
    if ($client->fault) {
        // An error has occurred
        die('An error has occurred!');
    } else {
        // Verify if a SOAP error wasn’t sent back
        $err = $client->getError();
        if ($err) {
            // Display the error
     echo 'SOAP Error: ' . $err ;
        } else {
     // All went well, you can process the result => $result
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        }
    }
?>
</body>
</html>
Customer service discussions
Loading...