# Delivery Reports

Delivery Report API allows you to get the status of the message  sent via Push API 

{% hint style="danger" %}
One API request takes 10 seconds to complete the message delivery if there are no message queue in your phone. **So please call this API after 1 minute from the time of message push.**\
\
We highly recommend to setup [Event Webhook ](/api-documentation-v2/event-webhook.md)to receive delivery reports as soon as its available and make use of this Delivery Report API only when you want to query the status of certain messages.
{% endhint %}

## Delivery Report API 

<mark style="color:green;">`POST`</mark> `https://pickyassist.com/app/api/v2/delivery-report`

This API allows you to fetch delivery reports for the messages sent through Push API

### Request URL (V4)

Method : **`POST`**

```
https://app.pickyassist.com/api/v2/push
```

#### Request Body

| Name     | Type   | Description                                                                                                                                 |
| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| token    | string | Your API Token for authentication                                                                                                           |
| push\_id | number | All Successful Push API requests gives you a push id as response , you need to use the **`"push_id"`** here to extract the delivery reports |

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

```javascript
{  
   "project_id":"3526",
   "push_id":590915,
   "application":"1",
   "message_type":"3",
   "time":"06-08-2019 06:46 AM",
   "data":[  
      {  
         "number":"3491934317",
         "msg_id":"1745955",
         "status":"1",
         "error_code":""
      },
      {  
         "number":"1947077634238",
         "msg_id":"1745956",
         "status":"2",
         "error_code":""
      },
      {  
         "number":"551984604233",
         "msg_id":"1745957",
         "status":"1",
         "error_code":""
      },
      {  
         "number":"76037143364",
         "msg_id":"1745958",
         "status":"1",
         "error_code":""
      },
      {  
         "number":"453491997414",
         "msg_id":"1745959",
         "status":"1",
         "error_code":""
      }
   ]
}
```

{% endtab %}
{% endtabs %}

## Sample Request Body JSON

```javascript
{
	"token": "YOUR API TOKEN",
	"push_id": 590915
}
```

## Sample Response

```javascript
{  
   "project_id":"3526",
   "push_id":590915,
   "application":"1",
   "message_type":"3",
   "time":"06-08-2019 06:46 AM",
   "data":[  
      {  
         "number":"3491934317",
         "msg_id":"1745955",
         "status":"1",
         "error_code":""
      },
      {  
         "number":"1947077634238",
         "msg_id":"1745956",
         "status":"2",
         "error_code":""
      },
      {  
         "number":"551984604233",
         "msg_id":"1745957",
         "status":"1",
         "error_code":""
      },
      {  
         "number":"76037143364",
         "msg_id":"1745958",
         "status":"1",
         "error_code":""
      },
      {  
         "number":"453491997414",
         "msg_id":"1745959",
         "status":"1",
         "error_code":""
      }
   ]
}
```

## Response Variables

| Variable           | Type    | Description                                                                                                                                                             |
| ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **status**         | numeric | Status of the Request, Refer [Status Code](/api-documentation-v2/references/status-and-error-codes.md)                                                                  |
| **error\_message** | text    | Message description in case of any errors, Refer [Status Code](/api-documentation-v2/references/status-and-error-codes.md)                                              |
| **push\_id**       | numeric | Unique id given by the PUSH API response                                                                                                                                |
| **project\_id**    | numeric | Unique id of the project                                                                                                                                                |
| **application**    | numeric | <p>Through which application the message has been triggered </p><p></p><p>1 = Whatsapp Personal </p><p>2 = Whatsapp Business<br>8 = WhatsApp Official</p><p></p>        |
| **message\_type**  | numeric | <p>Type of message<br></p><p>1 = image</p><p>2 = video</p><p>3 = text</p><p>4 = audio</p><p>5 = document</p><p></p>                                                     |
| **time**           | time    | Timezone in your account , and date format is DD-MM-YYYY hh:mm AM                                                                                                       |
| **data**           | Array   | Array containing the delivery report                                                                                                                                    |
| **msg\_id**        | numeric | Unique Message ID allocated to each number                                                                                                                              |
| **number**         | numeric | Number Passed in the Push API                                                                                                                                           |
| **status**         | numeric | <p>0 = Unknown</p><p>1 = Delivered </p><p>2 = Failed</p><p>3 = Read (Not supported in phone automation, if user privacy is on then this status will not get update)</p> |
| **error\_code**    | numeric | Future Scope                                                                                                                                                            |
| **error\_message** | text    | Future Scope                                                                                                                                                            |


---

# Agent Instructions: 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:

```
GET https://help.pickyassist.com/api-documentation-v2/push-api/delivery-reports.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.