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, it can also be sent in notifyUrl parameter. The URL sent in the parameter is deemed priority, and if the parameter is not sent or an incorrect URL is sent, the message delivery report is sent to the URL specified when the connection was configured.

HTTP method: POST.

Delivery Report#

 1 {
 2   "id":"8770599",
 3   "mtNum":"107930572",
 4   "status":2,
 5   "type":"SMS",
 6   "doneDate":"2019-05-05T10:20:35+0300",
 7   "submitDate":"2019-05-05T10:19:55+0300",
 8   "sourceAddr":"SOURCE",
 9   "destAddr": "72101234567",
10   "text":"message_text",
11   "partCount":"001",
12   "errorCode":"0",
13   "mccMnc":"25012",
14   "trafficType":0
15 }

Delivery Statuses#

Code

Delivery status

Description

0

SEND

Sent to the operator, the final status is not known yet.

2

DELIVERED

Delivered to the operator, after delivery it is possible to wait for the status of reading by the subscriber.

5

UNDELIVERED, REJECTED

Rejected by the operator/undelivered to the operator. The reason of non-delivery is specified in the errorCode parameter. It is the final status, no further statuses are expected.

9

READ

Status indicating the message is read by a subscriber. For all messages except FlashingCall and SMS. It is the final status, no further statuses are expected.

Description of Error Codes (parameter status=5)#

The section provides a description of the reasons for the non-delivery of messages of various types.

Code

Error message

Error description

1

unknown

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

7

timeout

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

8

unknown-subscriber

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

9

duplicated

A message was discarded by the platform as the function of cutting duplicate messages was activated.

11

unrouted

Routing error at the platform configurationы.

13

oper-invsrcaddr

Message sending from a sender’s name that is not registered by the operator.

18

bad-params

Invalid request parameters were specified or required parameters were not specified.

19

consumer-id-not-found

The card with the subscriber ID being sent was not found.

20

consumer-phone-not-found

The card with the subscriber’s telephone number being sent was not found.

21

no-primary-devices

The device is not the primary one. In case the sending was made to the primary device (primaryOn=true).

22

no-active-installations

No active mobile application installations were found on the user’s device.

23

push-disabled

The mobile application user has a ban on receiving push notifications at the application level.

24

push-os-disabled

The user’s mobile application has a ban on receiving push notifications at the operating system level.

25

subscription-failed

When sending the message subscriptions were specified that were not configured on the user’s mobile application installation.

26

no-application

No installation of the mobile application on the user’s device was found.

27

below-min-version

The application version is less than the minimum acceptable version. In the current implementation it is relevant for IOS only.

28

provider-error

APNS, FCM or HMS returned an error.