Receive delivery reports Webhook

For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer Support and they will set it up for you. Once the setup is complete, we will be able to deliver the reports to you in real time. Alternatively you can specify the endpoint per each message via the notifyURL parameter. Contact support@infobip.com if you require help. Use one URL for all report types.

Learn more about the WhatsApp channel and its use cases

post

https://{yourDomain}/your/webhook/path

Request Body schema:

application/json

collapse all -

results

Array of objects

Collection of reports, one per every message.

Array

bulkId

string

The ID that uniquely identifies the request.

price

object

Sent message price.

currency	string The currency in which the price is displayed.
pricePerMessage	number <double> The price per individual message.

status

object

Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.

groupName	string Group name for the status.
id	integer <int32> Status ID.
groupId	integer <int32> Status group ID.
name	string Status name.
action	string Action that should be taken to fix the error.
description	string Human-readable description of the status.

error

object

Indicates whether the error occurred during the query execution.

description	string Human-readable description of the error.
permanent	boolean Indicates whether the error is permanent.
name	string Error name.
id	integer <int32> Error ID.
groupName	string Error group name.
groupId	integer <int32> Error group ID.

messageId

string

The ID that uniquely identifies the message sent.

doneAt

string <date-time>

Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.).

messageCount

integer <int32>

The number of sent message segments.

sentAt

string <date-time>

Tells when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

string

The message destination address.

Responses

200

Your server returns this code if it accepts the callback

Request samples

Payload

Content type

application/json

Copy

Collapse all


{"results": 
[
{"bulkId": "",
"price": 
{"pricePerMessage": 0.21,
"currency": "BRL"
},
"status": 
{"id": 5,
"groupId": 3,
"groupName": "DELIVERED",
"name": "DELIVERED_TO_HANDSET",
"description": "Message delivered to handset"
},
"error": 
{"id": 0,
"name": "NO_ERROR",
"description": "No Error",
"groupId": 0,
"groupName": "OK",
"permanent": false
},
"messageId": "fb469d73-d362-463f-b30f-1e959b53badc",
"doneAt": "2019-04-09T16:01:56.494-0300",
"messageCount": 1,
"sentAt": "2019-04-09T16:00:58.647-0300",
"to": "41793026731"
}
]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use