+(923) 111 88 4444
TecniForge, 79/5-L, Sahiwal 57000

SMS – Get SMS Campaigns

SMS – Get SMS Campaigns

Get SMS Campaigns. Requires “get_sms_campaigns” API permission.GET https://androidapi.net/api/get/sms.campaigns

Parameter #

FieldTypeDescription
secretStringThe API secret you copied from (Tools -> API Keys) page
limit (optional)NumberLimit the number of results per page.Default value: 10
page (optional)NumberPagination of results.Default value: 1

Success Response Format #

FieldTypeDescription
statusNumberList of Codes
200 = Success
messageStringResponse message
dataArrayArray of data

Error Response Format #

NameTypeDescription
statusNumberList of Codes
400 = Invalid parameters
401 = Invalid API secret
403 = Access denied
500 = Something went wrong
messageStringResponse message
dataArrayArray 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/sms.campaigns?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/sms.campaigns", params = {
    "secret": apiSecret
})
  
# do something with response object
result = r.json()

Successful Response #

{
  "status": 200,
  "message": "SMS Campaigns",
  "data": [
       {
           "id": 1,
           "sender": "f1939aec-0d08-e221-3582-400511111108",
           "sender_type": "device",
           "status": "completed",
           "name": "Campaign Test",
           "contacts": 32,
           "created": 1662763259
       },
       {
           "id": 6,
           "sender": "f1939aec-0d08-e221-3582-400511111108",
           "sender_type": "device",
           "status": "running",
           "name": "World Test",
           "contacts": 2,
           "created": 1662799690
       },
       {
           "id": 14,
           "sender": "da6fcb98-3c6c-4554-3582-400511111108",
           "sender_type": "device",
           "status": "paused",
           "name": "Marketing",
           "contacts": 8,
           "created": 1662828578
       }
   ]
}

Error Response #

{
  "status": 400,
  "message": "Invalid Parameters!",
  "data": false
}

Leave A Comment