> For the complete documentation index, see [llms.txt](https://wiki.mobivatebulksms.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.mobivatebulksms.com/archived-docs/registering-webhooks/delivery-receipt-notification.md).

# Delivery Receipt Notification

When the status of a message changes, a notification will be **POSTed** to the specified webhook URL.

### Headers

| Header       | Value            |
| ------------ | ---------------- |
| Content-Type | application/json |

### Arguments

<table><thead><tr><th>Name</th><th width="131">Type</th><th>Description</th></tr></thead><tbody><tr><td>deliveryMessageId</td><td>string</td><td>Sent Message Id. </td></tr><tr><td>batchId</td><td>string</td><td>Batch ID of the message.</td></tr><tr><td>clientReference</td><td>string</td><td>Client message reference.</td></tr><tr><td>created</td><td>datetime</td><td>Date/Time receipt was received.</td></tr><tr><td>status</td><td>string</td><td>Message status, see <a href="#delivery-status-list">list of possible statuses</a>.</td></tr><tr><td>statusCode</td><td>integer</td><td>Message status in numeric value.</td></tr><tr><td>parts</td><td>integer</td><td>Number of parts in the message.</td></tr><tr><td>hlr</td><td>object</td><td>HLR Data, see <a href="/pages/ptwcJMb7ZQYqFiIZulsc">HLR documentation</a>.</td></tr></tbody></table>

### Examples

{% tabs %}
{% tab title="Payload" %}

```json
{
   "deliveryMessageId":"9A85B95E0A000A9D2FBD46710388AD54",
   "batchId":"9A85B9110A000A9D2FBD4671D691C328",
   "clientReference":null,
   "created":"2023-07-28T03:23:22.000+00:00",
   "status":"ACCEPTED",
   "statusCode":2,
   "parts":1,
   "hlr":null
}
```

{% endtab %}
{% endtabs %}

### Delivery Status List

<table><thead><tr><th width="307">Status</th><th width="113">Code</th><th>Description</th></tr></thead><tbody><tr><td>DELIVERED</td><td>1</td><td>Message successfully delivered to the handset.</td></tr><tr><td>ACCEPTED</td><td>2</td><td>Message accepted by carrier.</td></tr><tr><td>EXPIRED</td><td>3</td><td>The SMSC was unable to deliver the message in a specified amount of time (e.g. Phone is turned off).</td></tr><tr><td>DELETED</td><td>4</td><td>Message has been deleted.</td></tr><tr><td>UNDELIVERABLE</td><td>5</td><td>The SMS was unable to deliver the message (e.g. the number does not exist).</td></tr><tr><td>UNKNOWN</td><td>6</td><td>Unknown error occurred.</td></tr><tr><td>REJECTED</td><td>7</td><td>The message was rejected.</td></tr><tr><td>INTERIM_QUEUED</td><td>8</td><td>Message has been queued by next tier provider.</td></tr><tr><td>INTERIM_ACKNOWLEDGED</td><td>9</td><td>Message has been acknowledged by next tier provider.</td></tr><tr><td>RETRY</td><td>10</td><td>Message delivery will be retried.</td></tr><tr><td>FAILED_NACK</td><td>11</td><td>Message accepted but not delivered to the handset.</td></tr><tr><td>FAILED_NOROUTE</td><td>12</td><td>Provider could not route the message.</td></tr><tr><td>FAILED_INSUFFICIENT_CREDIT</td><td>17</td><td>Your account does not have sufficient credit to send the message.</td></tr><tr><td>FAILED_ORIGINATOR_RECIPIENT_EQUAL</td><td>18</td><td>Message originator and recipient are the same.</td></tr><tr><td>FAILED_RECIPIENT_BLACKLISTED</td><td>19</td><td>Recipient has been blacklisted.</td></tr><tr><td>FAILED_ORIGINATOR_REJECTED</td><td>20</td><td>Invalid message originator.</td></tr><tr><td>FAILED_ROUTE_INVALID</td><td>21</td><td>The selected Route ID cannot send messages to this recipient.</td></tr><tr><td>FAILED_LIMITS_EXCEEDED</td><td>22</td><td>Your account has exceeded its allocated limits.</td></tr><tr><td>FAILED_EXHAUSTED</td><td>24</td><td>Retries exhausted.</td></tr><tr><td>FAILED_INTERNAL_ERROR</td><td>28</td><td>Message failed to process/send due to internal error.</td></tr><tr><td>FAILED_UNKNOWN</td><td>29</td><td>Message failed to process/send due to unknown error.</td></tr><tr><td>REJECTED_INVALID_ORIGINATOR</td><td>33</td><td>Message rejected due to invalid originator.</td></tr><tr><td>REJECTED_INVALID_RECIPIENT</td><td>34</td><td>Message rejected due to invalid recipient.</td></tr><tr><td>REJECTED_INVALID_TEXT</td><td>36</td><td>Message rejected due to invalid text.</td></tr><tr><td>ERR_CONNECTION_NETWORK</td><td>40</td><td>Message failed to send due to connectivity issues.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.mobivatebulksms.com/archived-docs/registering-webhooks/delivery-receipt-notification.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
