Get detailed delivery report

JSON

A detailed Message delivery report may be requested by the Message identifier (received via API in the course of Messages creation: message_id) or by the additional identifier (set by you in JSON request: extra_id parameter).

To get the report using Message identifier, use the following URL: https://dr-v2.hyber.im/{client_id}/api/dr/{message_id}/advanced

To get the report using the additional identifier, use the following URL: https://dr-v2.hyber.im/{client_id}/api/dr/external/{extra_id}/advanced

An example of detailed delivery report:

{
  "reports": [
     {
       "phone_number": "380961111111",
       "message_id": "9f60ac8f-e721-5027-b838-e6fcb95fcd7a",
       "extra_id": "AD-6640-7006",
       "time": 1477417294667,
       "last_partner": "viber",
       "status": 3,
       "substatus": 35,
       "hyber_status": 35015
     },
     { 
       "phone_number": "380961111111",
       "message_id": "9f60ac8f-e721-5027-b838-e6fcb95fcd7a",
       "extra_id": "AD-6640-7006",
       "time": 1477417294667,
       "last_partner": "sms",
       "status": 2,
       "substatus": 23,
       "hyber_status": 23011,
       "total_sms_parts": 1,
       "delivered_sms_parts": 1
     }
   ],
   "started": true,
   "processing": false,
   "delivered_via": "sms",
   "channels": [{
       "channel": "viber",
       "ttl": 60
      },
      {
        "channel": "sms",
        "ttl": 300
      }
    ]
 }

If the Message is not sent to any of the communication channels, the status of the Message is -1. A description of the report parameters is provided in the Description Of The Request Parameters section.

XML

A detailed Message delivery report may be requested by the Message identifier (received via API in the course of Messages creation: message_id) or by the additional identifier (set by you in XML request: parameter).

To get the report using Message identifier, use the following URL: https://dr-v2.hyber.im/{client_id}/api/dr/{message_id}/advanced

To get the report using the additional identifier, use the following URL: https://dr-v2.hyber.im/{client_id}/api/dr/external/{extra_id}/advanced

An example of detailed delivery report:

<?xml version="1.0" encoding="UTF-8"?>
<message>
  <delivered_via>sms</delivered_via>
  <started>true</started>
  <processing>false</processing>
  <channels>
    <channels>
      <channel>sms</channel>
      <ttl>300</ttl>
    </channels>
    <channels>
      <channel>viber</channel>
      <ttl>60</ttl>
    </channels>
  </channels>
  <reports>
    <report>
      <status>2</status>
      <substatus>23</substatus>
      <hyber_status>23011</hyber_status>
      <last_partner>sms</last_partner>
      <message_id>9f60ac8f-e721-5027-b838-e6fcb95fcd7a</message_id>
      <phone_number>380961111111</phone_number>
      <extra_id>AD-6640-7006</extra_id>
      <time>1477417294667</time>
      <delivered_sms_parts>1</delivered_sms_parts>
      <total_sms_parts>1</total_sms_parts>
    </report>
    <report>
      <status>3</status>
      <substatus>35</substatus>
      <hyber_status>35015</hyber_status>
      <last_partner>viber</last_partner>
      <message_id>9f60ac8f-e721-5027-b838-e6fcb95fcd7a</message_id>
      <phone_number>380961111111</phone_number>
      <extra_id>AD-6640-7006</extra_id>
      <time>1477417294667</time>
    </report>
  </reports>
</message>

If the Message is not sent to any of the communication channels, the status of the Message is -1. A description of the report parameters is provided in the Description Of The Request Parameters section.