Retailer magic: SMS strategies for Winter | On Demand Sign up for our webinar
These API’s allow you to use the features that we built to allow us to comply with the GDPR regulations.
We offer an API that can be used to forget your data on our platform. You can also track the status of your requests.
When you request for your data to be forgotten it will be instantly added to your Blacklist. This means no further SMS will be sent to the destination numbers provided.
Within’ 24 hours off the request been submitted our system will go through your Contact Lists, Sent SMS, Received SMS, Blacklist and remove this data. Any numbers or an SMS body printed will be masked so it does not show the full number or message.
Once the process has completed the destination numbers will no longer be stored on our system.
/gdpr/forget
There are both required
and optional
properties for this API
Attribute | Type | Description |
---|---|---|
number | int | The number you want to be forgotten. The format of the number must begin with 44 |
Attribute | Type | Description |
---|---|---|
blacklist | boolean | Specify if you want to keep or remove a number in the Blacklisttrue - Number is removed from the Blacklistfalse - Number is left in the Blacklist |
Code Example
cURL
curl -X POST https://api.voodoosms.com/gdpr/forget \
-H "Authorization: Bearer {key}" \
-d '{
"number": 447000000123
}'
PHP
<?php
$api_key = 'API KEY';
$msg = json_encode(
[
"number" => 447000000123
]
);
$ch = curl_init('https://api.voodoosms.com/gdpr/forget');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: ' . $api_key
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $msg);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
Response
{
"status": "SUCCESS",
"msg": "Your request has been accepted",
"reference": "BWwmkoxO3YTfpEt",
"created_at": 1548892800
}
Code | Message | Meaning |
---|---|---|
76 | Cannot use this number | You have no affiliation with this number |
Error Response
{
"error": {
"code": 76,
"msg": "Cannot use this number"
}
}
If you have requested your data to be removed, you can check the status of your request as it can take up to 24 hours from making the original request
/gdpr/status
There are both required
and optional
properties for this API
Attribute | Type | Description |
---|---|---|
date | datetime, string | The date you submitted your removal request. Formats: UNIX: A UNIX timestamp (e.g. 1537525884 )ISO 8601: A string format including the time and timezone (e.g. 2018-02-22T09:03:00+00:00 )Human Readable: A human readable way to write the date or time you want to sent the message at (e.g. 25th December 2019 21:00 , 2 weeks , august 20 , may 11 2019 , last friday of march 2019 , next saturday ) |
Attribute | Type | Description |
---|---|---|
reference | string | The reference given to you when you made your request |
Code Example
cURL
curl -X POST https://api.voodoosms.com/gdpr/status \
-H "Authorization: Bearer {key}" \
-d '{
"date": "yesterday"
}'
PHP
<?php
$api_key = 'API KEY';
$msg = json_encode(
[
"date" => "yesterday"
]
);
$ch = curl_init('https://api.voodoosms.com/gdpr/status');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: ' . $api_key
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $msg);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
Response
{
"status": "SUCCESS",
"msg": "Your request has been accepted and is pending removal",
"reference": "BWwmkoxO3YTfpEt",
"created_at": 1548892800
}
// or
{
"status": "SUCCESS",
"msg": "The number has been removed",
"reference": "BWwmkoxO3YTfpEt",
"created_at": 1548892800
}
Code | Message | Meaning |
---|---|---|
77 | No records found | No requests have been made. |
78 | Request failed | The request failed. Please contact your Account Manager |
Error Response
{
"error": {
"code": 77,
"msg": "No records found"
}
}