This function would help you to retrieve a contact list and related information from MUMARA using API service request. The following section will explain the process of retrieving a subscriber list from MUMARA, by using a sample API request.
|
Username |
The email that account holder uses to login MUMARA |
|
API Token |
The API token user has generated using API Configuration section of MUMARA, also mentioned above. |
|
Method |
Method being called (Post) |
|
Path |
Path to the API file being called ('http//www.yourdomain.com/API/deleteSubscriber) |
|
Label/Variable |
Priority |
Description |
| list_id |
Required |
List ID is required in order to retrieve particular list from MUMARA. |
Sample Get List request retrieves list and returns obtained data in Json format. Sample request for list ID “2” is as follows.
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,'http://www.yourdomain.com/API/getList?list_id=2');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 60);
curl_setopt($ch, CURLOPT_HTTPHEADER, array( 'APIToken: 343b1b831067b50e308e6bf93e0f06f0', 'Login: [email protected]'));
$data = curl_exec($ch);
if (curl_errno($ch)) {
print "Error: " . curl_error($ch);
} else {
// Show me the result
print ($data);
curl_close($ch);
}
You will get the following response upon submitting appropriate request and correct ID of the particular list you want to retrieve from MUMARA.
Status value for successfully getting list will be- “success”
Data Returned- List ID, List Name, List Owner Name, List Owner Email, List Bounce Email, List Reply to Email, Number of Subscribers, Date of Creation
{"status":"success","response":[{"list_id":"2","list_name":"Example List","list_owner_name":"Testing Owner","list_owner_email":"[email protected]","list_bounce_email":"","list_reply_email":"[email protected]","contacts":"12","create_date":"2014-11-30"}]}
When you submit request with inappropriate, incorrect information.
Status value for unsuccessful submission will be-"error”
Data Returned- Text based message describing reason of unsuccessful response.