Delivery Reports

Overview

Delivery reports serve as your callback service, informing you of the status of messages sent to a specific destination (outbound message) or received on your Plivo number (inbound message).

When a call to the Message API to send a message completes successfully, your message is put into a queue to be sent to its destination. By default, you do not receive an automatic notification regarding the delivery of your message. To get notified about the status of your message, include the url parameter in your API request. This generates a notification when your message reaches its destination, or if it fails to deliver. Your delivery report will show the status — “queued”, “sent”, “delivered”, “undelivered” or “failed” — for each recipient, along with other parameters.

You can find SMS delivery reports by visiting Messaging > Logs on the Plivo console.

Similarly, if you want a delivery report when you receive an SMS message on your Plivo number, update the Message URL of the application associated with your Plivo number. Your delivery report will show the status — “delivered” or “undelivered” — along with incoming message details.

Note: Long SMS messages are automatically split for sending and concatenated upon receipt for a seamless user experience. When checking message logs and delivery reports for long SMS messages that are split, look for the MessageUUID, which is the same in all related split messages and identical to the UUID of the first message in the split sequence of messages.

Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API. If this is your first time using Plivo APIs, follow our instructions to set up a Ruby development environment and a web server and safely expose that server to the internet.

Here’s how the process works for inbound messages.

Inbound

Create the autoresponder application using Rails server

Edit app/controllers/plivo_controller.rb and paste into it this code.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

include Plivo
include Plivo::Exceptions
include Plivo::XML

class PlivoController < ApplicationController
  skip_before_action :verify_authenticity_token
  def delivery_report
		from_number = params[:From]
    to_number = params[:To]
    text = params[:Text]
		puts "Message received - From: #{from_number}, To: #{to_number}, Text: #{text}"

  	render json: "Report Received"
  	end
end

Add a route

Edit config/routes.rb and change the line

Rails.application.routes.draw do
  get 'plivo/sms' 
end

to

Rails.application.routes.draw do
  post 'plivo/delivery_report/' => 'plivo#delivery_report'
end

Test

Start the Rails server

$ rails server

You should see your basic server application in action at http://localhost:3000/plivo/delivery_report/.

Expose your local server to the internet.

Note: For ngrok testing, add this line to config/environments/development.rb.
config.hosts << /[a-z0-9-]+\.ngrok\.io/

Create an application

Associate the code you created with Plivo by creating a Plivo application. Visiting Messaging > Applications and click Add New Application. You can also use Plivo’s Application API.

Give your application a name — we called ours Delivery Reports. Enter the server URL you want to use (for example https://<yourdomain>.com/delivery_report/) in the Message URL field and set the method to POST. Click Create Application to save your application.

Create Application

Assign a Plivo number to your application

Navigate to the Numbers page and select the phone number you want to use for this application. From the Application Type drop-down, select XML Application. From the Plivo Application drop-down, select Receive SMS (the name we gave the application). Click Update Number to save.

Assign Phone Number to Receive Delivery Reports

Test

Send an SMS message to your Plivo number using a regular mobile phone. Plivo will send a request to your Message URL with the parameters listed in the Messaging documentation.

You can view the details posted by Plivo by looking at your terminal.

Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API. If this is your first time using Plivo APIs, follow our instructions to set up a Ruby development environment and a web server and safely expose that server to the internet.

Here’s how the process works for outbound messages.

Outbound

Create the autoresponder application using Rails server

Edit app/controllers/plivo_controller.rb and paste into it this code.

1
2
3
4
5
6
7
8
9
10
11
12
13
14

include Plivo
include Plivo::Exceptions
include Plivo::XML

class PlivoController < ApplicationController
  skip_before_action :verify_authenticity_token
  def delivery_report
        from_number = params[:From]
   		to_number = params[:To]
    	status = params[:Status]
		puts "Message received - From: #{from_number}, To: #{to_number}, Status: #{status}"
  	render json: "Report Received"
	end
end

Add a route

Edit config/routes.rb and change the line

Rails.application.routes.draw do
  get 'plivo/sms' 
end

to

Rails.application.routes.draw do
  post 'plivo/delivery_report/' => 'plivo#delivery_report'
end

Start the Rails server

$ rails server

You should see your basic server application in action at http://localhost:3000/plivo/delivery_report/.

Expose your local server to the internet.

Note: For ngrok testing, add this line to config/environments/development.rb.
config.hosts << /[a-z0-9-]+\.ngrok\.io/

Test

To test delivery reports on outbound messages, send an SMS message to a mobile phone using this code.

1
2
3
4
5
6
7
8
9
10
11

require "plivo"
include Plivo

api = RestClient.new("<auth_id>","<auth_token>")
response = api.messages.create(
	src: "<sender_id>",
	dst:"<destination_number>",
	text:"Hello, this is a sample text",
	url: "https://<ngrok_url>/delivery_report/",
)
puts response

Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234) and url with the ngrok-generated URL.

Plivo will send a request to your url with the parameters listed in the Messaging documentation.

You can view the details posted by Plivo by looking at your terminal.