autoresponderGetList
public static array autoresponderGetList(string token, integer pageNumber, integer pageSize, string orderBy , string filter , string sortOrder)
Get the list of Autoresponders using the filter and paging limits, order by the name or date of the Autoresponder.
| Parameters |
| string token | A valid token for your account. To generate a token, use the login method. |
| integer pageNumber | Fetch results from the given page number. |
| integer pageSize | Number of results per page. |
| string orderBy | Sort the results based on "name" or "date". |
| string filter | Show autoresponders where the autoresponder name starts with the filter |
| string sortOrder | Sort the results in the "asc"ending or "desc"ending order. |
| Returns |
| array | Returns an array with the results. |
| Return Structure |
| integer sequence | The sequence number of the record |
| string id | The ID of the Autoresponder campaign. To get the details of this campaign, use the autoresponderGetDetail method. |
| string autoresponderName | Name of the Autoresponder campaign |
| string totalEmails | No of levels of the Autoresponder campaign |
| string status | Status of the Autoresponder campaign, 1 for active for 0 for inactive |
| string modifiedDate | The date on which the Autoresponder was last updated |
- <?php
- /**
- This Example shows how to authenticate a user using XML-RPC.
- Note that we are using the PEAR XML-RPC client and recommend others do as well.
- **/
- require_once 'XML/RPC2/Client.php';
- require_once 'inc/config.php';
- $client = XML_RPC2_Client::create($apiURL);
- $token = $client->login($apiLogin, $apiPassword);
- $retval = $client->autoresponderGetList($token, 1, 10, '', '', '');
-
- foreach($retval as $rec) {
- echo $rec['sequence'] . "] Autoresponder Name: " . $rec['autoresponderName'] . "(" . $rec['id'] . ")";
- echo "\t Autoresponder levels:" . $rec['totalEmails'];
- echo "\t status: " . $rec['status'];
- echo "\t Updated Date: " . $rec['modifiedDate'];
- echo "<br />";
- }
-
- ?>