Table of Contents
Get Unsubscribed Contacts. Requires “get_unsubscribed” API permission.GET https://androidapi.net/api/get/unsubscribed
Parameter #
| Field | Type | Description |
|---|---|---|
| secret | String | The API secret you copied from (Tools -> API Keys) page |
| limit (optional) | Number | Limit the number of results per page.Default value: 10 |
| page (optional) | Number | Pagination of results.Default value: 1 |
Success Response Format #
| Field | Type | Description |
|---|---|---|
| status | Number | List of Codes 200 = Success |
| message | String | Response message |
| data | Array | Array of data |
Error Response Format #
| Name | Type | Description |
|---|---|---|
| status | Number | List of Codes 400 = Invalid parameters 401 = Invalid API secret 403 = Access denied 500 = Something went wrong |
| message | String | Response message |
| data | Array | Array of data |
PHP Sample #
<?php
$apiSecret = "API_SECRET"; // your API secret from (Tools -> API Keys) page
$cURL = curl_init();
curl_setopt($cURL, CURLOPT_URL, "https://androidapi.net/api/get/unsubscribed?secret={$apiSecret}");
curl_setopt($cURL, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($cURL);
curl_close($cURL);
$result = json_decode($response, true);
// do something with response
print_r($result);Python Sample #
import requests
# your API secret from (Tools -> API Keys) page
apiSecret = "API_SECRET"
r = requests.get(url = "https://androidapi.net/api/get/unsubscribed", params = {
"secret": apiSecret
})
# do something with response object
result = r.json()Successful Response #
{
"status": 200,
"message": "Unsubscribed Contacts",
"data": [
{
"id": 2,
"phone": "+639694967617",
"created": 1645755138
}
]
}Error Response #
{
"status": 400,
"message": "Invalid Parameters!",
"data": false
}
