Autumn Offer

50% Free

* Terms & conditions apply

Delivery Reports

Get the status’ of your messages that you have sent out.

Optional Properties

Attribute Type Description Default
message_id string The messages.id attribute in the response given after using the Sending SMS API.
sender_id string,int The Sender ID used to send with the message.
to int The number you have sent messages to.
sent_at datetime,string A date of when a message was sent.

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)
delivered_at datetime,string A date of when a message was delivered or marked as Not Delivered.

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)
external_reference string The external refernece if used when sending an SMS.
status string The status of your messages.

Available options:
Delivered
Sent - Awaiting Delivery
Undelivered
Expired
Rejected
Not Delivered
start datetime,string A start date or time of when you want to start filtering your messages from.
end datetime,string The latest date or time you want to stop filtering at.
limit int Return the number of delivery reports. 25

Request

GET /report
Example Code

cURL

curl https://api.voodoosms.com/report \
  -H "Authorization: Bearer {key}"

PHP

<?php

$api_key = 'API KEY';

$ch = curl_init('https://api.voodoosms.com/report');

curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: ' . $api_key
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

curl_close($ch);
Response
{
  "limit": 25,
  "report" [
    {
      "message_id": "97709216074987x3NFD16GgkChK2E67441209181vapi",
      "sender_id": "Chris",
      "to": 447000000000,
      "sent_at": 1542120829,
      "delivered_at": 1542120852,
      "price": 2.9,
      "status": "DELIVERED"
    }
  ]
}

Errors

Code Message Meaning
23 Invalid ID The ID used is invalid or not related to your account.
Error Response
{
  "error": {
    "code": 23,
    "msg": "Invalid ID"
  }
}