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.
post
https://pickyassist.com/app/api/v2
/delivery-report
Delivery Report API
Sample Request Body JSON
1
{
2
"token": "YOUR API TOKEN",
3
"push_id": 590915
4
}
Copied!
Sample Response
1
{
2
"project_id":"3526",
3
"push_id":590915,
4
"application":"1",
5
"message_type":"3",
6
"time":"06-08-2019 06:46 AM",
7
"data":[
8
{
9
"number":"3491934317",
10
"msg_id":"1745955",
11
"status":"1",
12
"error_code":""
13
},
14
{
15
"number":"1947077634238",
16
"msg_id":"1745956",
17
"status":"2",
18
"error_code":""
19
},
20
{
21
"number":"551984604233",
22
"msg_id":"1745957",
23
"status":"1",
24
"error_code":""
25
},
26
{
27
"number":"76037143364",
28
"msg_id":"1745958",
29
"status":"1",
30
"error_code":""
31
},
32
{
33
"number":"453491997414",
34
"msg_id":"1745959",
35
"status":"1",
36
"error_code":""
37
}
38
]
39
}
Copied!
Response Variables
Variable
Type
Description
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 modified 2yr ago