Delivery Status Service#

Service Setup#

The Service Provider sends a message delivery report to the Partner’s URL configured to send delivery statuses.

The URL for statuses is set in the integration settings when enabling the service.

The message delivery status is returned in the status parameter.

Important

For SMS messages sent to subscribers of the MegaFon operator, the reporting of statuses 2 (delivered) and 5 (undelivered) has been discontinued since March 1, 2023.

Extended statuses of sent messages are available optionally. To receive extended statuses you need to contact the the Technical Support.

HTTP method: GET.

Interaction protocol: HTTP 1.1.

The interaction is synchronous.

Interaction#

The way of interaction:

  1. The Partner sends to the Service Provider a request to send a message.

  2. The Service Provider processes the request, returns the message identifier to the Partner.

  3. The Service Provider processes the message — sends the message to the Operator for sending to the subscriber.

  4. The Operator sends a message to the subscriber and returns the delivery status to the Service Provider.

  5. The Service Provider sends a request to the Partner containing information about the message delivery status.

GET Request#

Example of a request from a Service Provider to a Partner for sending message statuses.

{
  http://partner.url?msgType=SMS&transactionId=7986985&ptag=test&status=2
}

Response#

The Partner must synchronously respond to the request with one of the HTTP statuses.
The description of the statuses, as well as the procedure for the actions of the Service Provider when receiving these statuses, are shown in the table.

Status

Description

Service Provider’s Action

200

ОК. Successful processing of the request by the Partner.

Final status. Regular work.

400

Incorrect values of parameters: transactionId or ptag identifiers that do not exist in the Partner’s database.

The Service Provider resends the request to the Partner according to the service configuration.

500

Server internal error. Technical difficulties at the Partner’s side.

Error codes#

This section describes the reasons for non-delivery of various types of messages (unifiedExtStatus parameter, see GET Request).

Value of unifiedExtStatus

Description of statuses

1

An error unknown to the platform occurred during the the message delivery process, or the operator did not provide an error in the delivery report.

2

The subscriber’s device was turned off or it was out of network coverage during the entire attempt to deliver the message.

3

The subscriber’s device is blocked, either the subscriber has the ban on receiving messages enabled, or the subscriber is in roaming with the ban on receiving messages while roaming enabled.

4

An error occurred at the transport layer of the signaling network during the delivery of the message.

5

The subscriber’s phone memory is full.

6

The subscriber does not have the message receiving service activated.

7

The switching equipment on which the subscriber is registered isn’t responding.

8

The subscriber’s phone number is incorrect, or the subscriber’s phone has been switched off for a very long time.

9

The message was discarded by the platform due to the duplicate message filtering mechanism.

Details

Example: Message Duplicate Blocking (Partner Feature Enabled)

If a Partner sends multiple message requests within a 24-hour period containing the same partnerMsgId parameter or the same text to the same subscriber number.

The first request will be successfully processed, and the message will be delivered to the subscriber.

In response to subsequent requests, the Service Provider will return an error code to the Partner and will not send these messages to the subscriber.

Duplicate requests with the same partnerMsgId value are blocked for 12 hours.

Duplicate requests with the same message text are blocked for 24 hours.

The duplicate blocking feature is disabled for the Partner by default. It can be enabled upon the Partner's request.

10

The message was discarded by the platform because one of the message filters, such as a spam filter, was triggered.

11

Routing error at the platform configuration.

12

The subscriber’s number is on the operator’s blacklist.

13

Sending a message from a sender’s name that is not registered by the operator.

14

On the operator’s side, a SPAM filter was activated based on the text of the message.

16

At the time of message delivery, the phone was busy either receiving or transmitting another short message.

18

When sending a message, one or more message parameters were specified incorrectly, or mandatory parameters were not included.

20

The subscriber’s phone does not accept messages.

28

The message was sent to a number belonging to another mobile operator.