Delivery Reports

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

Requires Bridge App 4.3 or above

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 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.

Delivery Report API

POST https://pickyassist.com/app/api/v2/delivery-report

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

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

{  
   "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":""
      }
   ]
}

Sample Request Body JSON

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

Sample Response

{  
   "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

error_message

text

push_id

numeric

Unique id given by the PUSH API response

project_id

numeric

Unique id of the project

application

numeric

Through which application the message has been triggered

1 = Whatsapp Personal

2 = Whatsapp Business 8 = WhatsApp Official

message_type

numeric

Type of message

1 = image

2 = video

3 = text

4 = audio

5 = document

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

0 = Unknown

1 = Delivered

2 = Failed

3 = Read (Not supported in phone automation, if user privacy is on then this status will not get update)

error_code

numeric

Future Scope

error_message

text

Future Scope

Last updated