segmentGetContacts
public static array segmentGetContacts(string token, string segmentID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
Get the contacts from the segment.
Section
Contact List Related Methods

Parameters
string tokenA valid token for your account. To generate a token, use the login method.
string segmentIDThe segment ID from which you want to retrieve records. To get the segments in your account, use the segmentGet method.
string filterShow contacts where the email address contains with the filter
integer pageNumberFetch results from the given page number.
integer pageSizeNumber of results per page.
string orderBySort the results based on "email" or "date".
string sortOrderSort the results in the "asc"ending or "desc"ending order.

Returns
arrayReturns an array with the results.

Return Structure
integer sequenceThe sequence number of the record
string idThe ID of the contact
string emailEmail Address of the contact. To get all the details for the contact, use the listGetContactDetails method.
string firstnameFirst name of the contact
string middlenameMiddle name of the contact
string lastnameLast name of the contact


Examples
download example code
xmlrpc_segmentGetContacts.php


  1. <?php
  2. /**
  3. This Example shows how to authenticate a user using XML-RPC.
  4. Note that we are using the PEAR XML-RPC client and recommend others do as well.
  5. **/
  6. require_once 'XML/RPC2/Client.php';
  7. require_once 'inc/config.php';
  8. $client = XML_RPC2_Client::create($apiURL);
  9. $token = $client->login($apiLogin, $apiPassword);
  10. /**
  11. Fetch the latest segment list, so we can retrieve the segment ID.
  12. **/
  13. $segmentLists = $client->segmentGet($token, "", 1, 1, "");
  14. $segmentID = $segmentLists[0]['id'];
  15.  
  16. $contacts = $client->segmentGetContacts($token, $segmentID, "", 1, 100, "");
  17.  
  18. foreach($contacts as $rec) {
  19.     echo $rec['sequence'] . "] Email: " . $rec['email'] . "(" . $rec['id'] . ")";
  20.     echo "\t Name:" . $rec['firstname'] . " " . $rec['middlename'] . " " . $rec['lastname'];
  21.     echo "<br />";
  22. }
  23.  
  24. ?>