Nvia Technical Guides
SMS API Wiki 1.0
SMS API Wiki 1.0
  • Basics
    • Glossary
  • 1. Sending SMS-MT
    • 1.1 Interfaces
      • 1.1.1 HTTP Request
        • Sending text, flash and binary messages
        • Sending WAP push messages
      • 1.1.2 JSON Request
        • Sending text, flash and binary messages
        • Sending WAP push messages
      • 1.1.3 Webservices
        • Sending text, flash and binary messages
        • Sending WAP push messages
      • 1.1.4 SMPP interface
        • About the SMPP interface
        • Date time formats for scheduled delivery and validity period
    • 1.2 Date time formats
    • 1.3 Error Codes
    • 1.4 Delivery Report Callback
  • 2. SMS - 2 Ways
    • 2.1 Sonic MQ
    • 2.2 HTTP with Content-Reply (Synchronous)
    • 2.3 HTTP (2 requests)
    • 2.4 Unanswered messages
    • 2.5 Delivery reports (DLR)
  • 3. SMS Certified by Blockchain
    • 3.1 SMS Certified by Blockchain
    • 3.2 Sending a SMS certified by blockchain
  • EXAMPLES
    • GitHub sendMtSms
Powered by GitBook
On this page
  • About Delivery Reports
  • Status Codes for Delivery Reports
  • Callback Response
  1. 1. Sending SMS-MT

1.4 Delivery Report Callback

About Delivery Reports

When sending SMS over HTTP, the user may request Nvia to receive the delivery reports in a given URL. The delivery reports will then be sent by HTTP callbacks to the afore mentioned URL with two extra parameters: the message Identifier and the status.

The message identifier (GET Parameter: ID) is previously sent to the user as a response to the HTTP callback. The user must store this ID and use it to match with the HTTP callback that contains the dlr.

The message identifier (GET Parameter: transactionId) sent by the user or generated by Nvia, anyhow returned in the request when sending the SMS.

When sending SMS over HTTP, the user may request Nvia to receive the delivery reports in a given URL. This callback URL can be configured as a send request parameter or it can be configured in the panel as a static URL to be used when callback parameter is not configured in the request.

The delivery reports will then be sent by HTTP callbacks to the afore mentioned URL with the following parameters:

Parameters
Description

status

DLR status, All available status codes are described in Status Codes for Delivery Reports table bellow

msisdn

Destination MSISDN

date

Date and time when the message was delivered to the user. Format: ddMMyyhhmm

transactionId

client transaction ID

Status Codes for Delivery Reports

Besides the ID parameter, the DLR callbacks contain a second parameter called status. The status parameter will contain, textually, information regarding the status of the SMS. The possible statuses are presented in the section called Status codes.

Nvia provides a group of five different status codes with the delivery reports. You may find these below:

STATUS CODE
DESCRIPTION

DELIVERED

Final state. Received when the message has been successfully delivered to the handset

EXPIRED

Final state. Received when the message hasn’t been delivered to the handset because the message validity period has gone by.

UNDELIVERABLE

Final state. Received when the message hasn’t been delivered to the handset because of a possible error (for instance, invalid address).

ENROUTE

Intermediate state. Received if the message has been sent to the operator but hasn’t yet reached the handset.

ACCEPTED

Intermediate state. Received if the message has been sent to the operator but hasn’t yet reached the handset.

REJECTED

Final state. Received if the operator rejected the SMS.

QUEUED

Intermediate state. Received if the messages are queued awaiting delivery

Callback Response

The correct response may have different formats according to the Content Type header:

  • Content Type: text/plain

  • Content Type: application/json

Last updated 1 year ago