Delivery Receipts
You can verify that a message you sent using the Vonage SMS API reached your customer by requesting a delivery receipt from the carrier.
NOTE: Not all networks and countries support delivery receipts. You can check our knowledge base for some further information on what you might receive if your network does not support delivery receipts. For detailed information on delivery receipts see our documentation.
To access the delivery receipt, you need to:
- Create a webhook endpoint using one of the code examples shown below
- Configure the webhook endpoint in your Vonage Dashboard
NOTE: After you send a message there may be a delay before you receive the delivery receipt.
Prerequisites
npm install express body-parserCreate a file named dlr-express.js and add the following code:
const app = require('express')()
const bodyParser = require('body-parser')
app.use(bodyParser.json())
app.use(bodyParser.urlencoded({ extended: true }))
Write the code
Add the following to dlr-express.js:
app
.route('/webhooks/delivery-receipt')
.get(handleDeliveryReceipt)
.post(handleDeliveryReceipt)
function handleDeliveryReceipt(request, response) {
const params = Object.assign(request.query, request.body)
console.log(params)
response.status(204).send()
}
app.listen(process.env.PORT || 3000)
Run your code
Save this file to your machine and run it:
node dlr-express.jsPrerequisites
Add the following to `build.gradle`:
compile 'com.vonage:client:5.5.0'
compile 'com.sparkjava:spark-core:2.7.2'Write the code
Add the following to the main method of the ReceiveDLR class:
port(3000);
get("/webhooks/delivery-receipt", (req, res) -> {
for (String param : req.queryParams()) {
System.out.printf("%s: %s\n", param, req.queryParams(param));
}
res.status(204);
return "";
});
post("/webhooks/delivery-receipt", (req, res) -> {
// The body will be form-encoded or a JSON object:
if (req.contentType().startsWith("application/x-www-form-urlencoded")) {
for (String param : req.queryParams()) {
System.out.printf("%s: %s\n", param, req.queryParams(param));
}
} else {
IncomingDlrPayload jsonPayload = IncomingDlrPayload.fromJson(req.bodyAsBytes());
System.out.println(jsonPayload);
}
res.status(204);
return "";
Run your code
We can use the application plugin for Gradle to simplify the running of our application.
Update your build.gradle with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''
Run the following gradle command to execute your application, replacing com.vonage.quickstart.sms with the package containing ReceiveDLR:
gradle run -Pmain=com.vonage.quickstart.sms.ReceiveDLRPrerequisites
Install-Package VonageCreate a file named SmsController.cs and add the following code:
using Vonage.Messaging;
using Vonage.Utility;
Write the code
Add the following to SmsController.cs:
[HttpGet("webhooks/delivery-receipt")]
public async Task<IActionResult> DeliveryReceipt()
{
var dlr = WebhookParser.ParseQuery<DeliveryReceipt>(Request.Query);
Console.WriteLine($"Delivery receipt received for messages {dlr.MessageId} at {dlr.MessageTimestamp}");
return NoContent();
}
Prerequisites
composer require slim/slim:^3.8 vonage/clientCreate a file named index.php and add the following code:
use \Psr\Http\Message\ServerRequestInterface as Request;
use \Psr\Http\Message\ResponseInterface as Response;
Write the code
Add the following to index.php:
$handler = function (Request $request, Response $response) {
$receipt = \Vonage\SMS\Webhook\Factory::createFromRequest($request);
error_log(print_r($receipt, true));
return $response->withStatus(204);
};
$app->map(['GET', 'POST'], '/webhooks/delivery-receipt', $handler);
$app->run();
Run your code
Save this file to your machine and run it:
php -S localhost:3000 -t .Prerequisites
pip install flaskCreate a file named dlr-flask.py and add the following code:
from pprint import pprint
from flask import Flask, request
app = Flask(__name__)
Write the code
Add the following to dlr-flask.py:
@app.route('/webhooks/delivery-receipt', methods=['GET', 'POST'])
def delivery_receipt():
if request.is_json:
pprint(request.get_json())
else:
data = dict(request.form) or dict(request.args)
pprint(data)
return ('', 204)
app.run(port=3000)
Run your code
Save this file to your machine and run it:
python dlr-flask.pyPrerequisites
gem install sinatra sinatra-contribCreate a file named delivery_receipt.rb and add the following code:
require 'sinatra'
require 'sinatra/multi_route'
require 'json'
helpers do
def parsed_body
json? ? JSON.parse(request.body.read) : {}
end
def json?
request.content_type == 'application/json'
end
end
Write the code
Add the following to delivery_receipt.rb:
route :get, :post, '/webhooks/delivery-receipt' do
puts params.merge(parsed_body)
status 204
end
set :port, 3000
Run your code
Save this file to your machine and run it:
ruby delivery_receipt.rbConfigure the webhook endpoint in your Vonage Dashboard
So that Vonage knows how to access your webhook, you must configure it in your Vonage account.
In the code snippets, the webhook is located at /webhooks/delivery-receipt. If you are using Ngrok, the webhook you need to configure in your Vonage Dashboard API Settings page is of the form https://demo.ngrok.io/webhooks/delivery-receipt. Replace demo with the subdomain provided by Ngrok and enter your endpoint in the field labeled Webhook URL for Delivery Receipts:
Try it out
Send a message to a mobile number and, if the network supports it, you will receive a delivery receipt in the following format:
{
"err-code": "0",
"message-timestamp": "2020-10-25 12:10:29",
"messageId": "0B00000127FDBC63",
"msisdn": "447700900000",
"network-code": "23410",
"price": "0.03330000",
"scts": "1810251310",
"status": "delivered",
"to": "Vonage"
}
NOTE: After you send a message there may be a delay before you receive the delivery receipt.