Delivery Reports

Get Delivery Status

This call is used to get the delivery status of a specific SMS sent via API.

Definition

http:// or https:// www.voodooSMS.com/vapi/server/getDlrStatus

Methods

GET

Required Parameters

uid: System allocated username for API user configured within the VoodooSMS.com Portal in ‘Send SMS>API Management’
pass: System password for API user configured within the VoodooSMS.com Portal in ‘Send SMS>API Management’
format: Return format requested: XML, JSON or PHP data.

Optional Parameters

reference_id: message identifier

Getting reports without any query parameter

Request
<?php
switch($_SERVER["REQUEST_METHOD"]) {
     case "GET":
          $uid = htmlspecialchars($_GET["uid"]);
          $pass = htmlspecialchars($_GET["pass"]);
          $format = htmlspecialchars($_GET["format"]);
     break;
     case "POST":
          $uid = htmlspecialchars($_POST["uid"]);
          $pass = htmlspecialchars($_POST["pass"]);
          $format = htmlspecialchars($_POST["format"]);
     break;
}

$url = "https://www.voodoosms.com/vapi/server/getDlrStatus?uid=".$uid."&pass=".$pass."&format=".$format;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
// Download the given URL, and return output
$output = curl_exec($ch);
echo $output."   ".curl_error($ch);
 // Close the cURL resource, and free system resources
curl_close($ch);
?>
Response
<xml>
   <result>200 OK</result>
   <reference_id>216533234937483</reference_id>
   <delivery_status>Not Delivered</delivery_status>
   <delivery_datetime />
</xml>

Get Delivery Report

This provides the delivery status for any SMS sent either today, or for a specified period using the optional date, sh and eh parameters.

Definition

http:// or https:// www.voodooSMS.com/vapi/server/getDLR

URL

For Today: http:// or https:// www.voodooSMS.com/vapi/server/getDLR?uid={username}&pass={password}

For a specific date:
http:// or https://

Methods

GET

Required Parameters

uid: System allocated username for API user configured within the VoodooSMS.com Portal in ‘Send SMS>API Management’
pass: System password for API user configured within the VoodooSMS.com Portal in ‘Send SMS>API Management’
format: Return format requested: XML, JSON or PHP data.

Optional Parameters

date: Specify the date you wish to get delivery reports for - format yyyy-mm-dd
sh: Specify the start hour - format hh
eh: Specify the end hour format hh

Getting reports without any query parameter

Request
<?php
switch($_SERVER["REQUEST_METHOD"]) {
     case "GET":
          $uid = htmlspecialchars($_GET["uid"]);
          $pass = htmlspecialchars($_GET["pass"]);
          $format = htmlspecialchars($_GET["format"]);
     break;
     case "POST":
         $uid = htmlspecialchars($_POST["uid"]);
         $pass = htmlspecialchars($_POST["pass"]);
         $format = htmlspecialchars($_POST["format"]);
     break;
}

$url = 'https://www.voodoosms.com/vapi/server/getDLR?uid='.$uid.'&pass='.$pass."&format=".$format;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
// Download the given URL, and return output
$output = curl_exec($ch);
echo $output."   ".curl_error($ch);
 // Close the cURL resource, and free system resources
curl_close($ch);
?>
Response
<xml>
   <item>
      <destination_number>447700900600</destination_number>
      <delivery_status />
      <delivery_datetime />
      <reference_id>1501051855auto_booking294</reference_id>
   </item>
   <item>
      <destination_number>447700900600</destination_number>
      <delivery_status />
      <delivery_datetime />
      <reference_id>1501051856auto_booking295</reference_id>
   </item>
</xml>

Get Delivery Report External Reference

This provides the delivery status for any SMS sent either today, or for a specified period and also includes the external reference field (when supplied using sendSMS using the optional ‘er’ parameter)

Definition

http:// or https:// www.voodooSMS.com/vapi/server/getDLRer

For Today: http:// or https:// www.voodooSMS.com/vapi/server/getDLRer?uid={username}&pass={password}

For a specific date:
http:// or https://

Methods

GET

Required Parameters

uid: System allocated username for API user configured within the VoodooSMS.com Portal in ‘Send SMS>API Management’
pass: System password for API user configured within the VoodooSMS.com Portal in ‘Send SMS>API Management’
format: Return format requested: XML, JSON or PHP data.

Optional Parameters

date: Specify the date you wish to get delivery reports for - format yyyy-mm-dd
sh: specify the start hour - format hh
eh: specify the end hour format hh

Getting reports without any query parameter

Request
<?php
switch($_SERVER["REQUEST_METHOD"]) {
     case "GET":
          $uid = htmlspecialchars($_GET["uid"]);
          $pass = htmlspecialchars($_GET["pass"]);
          $format = htmlspecialchars($_GET["format"]);
     break;
     case "POST":
         $uid = htmlspecialchars($_POST["uid"]);
         $pass = htmlspecialchars($_POST["pass"]);
         $format = htmlspecialchars($_POST["format"]);
     break;
}

$url = 'https://www.voodoosms.com/vapi/server/getDLRer?uid='.$uid.'&pass='.$pass."&format=".$format;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
// Download the given URL, and return output
$output = curl_exec($ch);
echo $output."   ".curl_error($ch);
 // Close the cURL resource, and free system resources
curl_close($ch);
?>
Response
<xml>
   <item>
      <destination_number>447700900600</destination_number>
      <delivery_status />
      <delivery_datetime />
      <eref />
      <reference_id>1501051855auto_booking294</reference_id>
   </item>
   <item>
      <destination_number>447700900600</destination_number>
      <delivery_status />
      <delivery_datetime />
      <eref />
      <reference_id>1501051856auto_booking295</reference_id>
   </item>
</xml>