GDPR

Forget Request

When you call the forget API the number will be instantly added to your blacklist so that no further SMS is sent to the CLI (destination number) supplied. Then, within 24 hours of the time of the request the VoodooSMS platform will work through your contact lists, sent SMS, received SMS, Blacklist etc to either delete the CLI or mask the CLI from your records along with the content of the SMS. In the case of outbound SMS, we will have the CLI masked so that only the first 6 digits remain, making it impossible to identify the destination number, and the body of the SMS removed, e.g. API / Web SMS, this is purely from an accounting perspective so that the credit spend can be tracked.

Once the process is complete, the CLI / Destination number will not be stored anywhere on our platform, this includes your blacklist. If an SMS is sent via Web SMS / API etc via your account to the CLI the VoodooSMS platform will send it, even if you have made a forget request prior.

Definition

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

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’
cc: Check & reformat destination number feature if you choose to specify the country code in the sendSMS API Call, e.g. 44 and the API will check that the specified destination number Examples
* If dest=447700900000 and cc=44 - no change will be made.
* If dest=07700900000 and cc=44 - dest will be changed to 447700900000
* If dest=7700900000 and cc=44 - dest will be changed to 447700900000
format: Return format requested: XML, JSON or PHP data.

Optional Parameters

bl: You can keep or delete the number in the blacklist.
* if bl = 0 - number will be deleted from blacklist
* If bl = 1 or empty - number will stay in blacklist

Forget without any query parameter

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

$url = 'https://www.voodoosms.com/vapi/server/forget?uid='.$uid.'&pass='.$pass.
        '&cc='.$cc.'&cli='.$cli.'&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>202</result>
   <message>Your request has been accepted and is pending</message>
   <reference>BWwmkoxO3YTfpEt</reference>
   <date>2018-05-02 10:33:37</date>
</xml>

Forget Status

This API call will check the status on any given day of previous API calls to forget a CLI (destination number). This API call will return the current status

Definition

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

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’
date: Specify the date you wish to forget for - format yyyy-mm-dd
format: Return format requested: XML, JSON or PHP data.

Forget Status without any query parameter

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

$url = 'https://www.voodoosms.com/vapi/server/forgetstatus?uid='.$uid.'&pass='.$pass.'&date='
    .$date.'&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>
      <result>202</result>
      <message>Your request has been accepted and is pending removal</message>
      <reference>BWwmkoxO3YTfpEt</reference>
      <date>2018-05-17 00:23:37</date>
   </item>
</xml>

Or if more than one request has been made and is still pending:

<xml>
   <item>
      <result>202</result>
      <message>Your request has been accepted and is pending removal</message>
      <reference>BWwmkoxO3YTfpEt</reference>
      <date>2018-05-17 00:23:37</date>
   </item>
   <item>
      <result>202</result>
      <message>Your request has been accepted and is pending removal</message>
      <reference>yt9jDd6EXPnJBaT</reference>
      <date>2018-05-17 00:25:17</date>
   </item>
</xml>

For the check status (forgetstatus), this will return a list of your outstanding requests referenced by the reference value returned on the original forget request. Once a request has been completed, this status will change as per the following example:

<xml>
   <item>
      <result>200</result>
      <message>The CLI has been removed</message>
      <reference>BWwmkoxO3YTfpEt</reference>
      <date>2018-05-17 03:00:15</date>
   </item>
</xml>