Get Delivery Receipts
Get the delivery receipt(s) for a batch
Request
Endpoint
Messaging Plus expects a POST request
https://mplus.instagiv.com/batch/{batch-uuid}| Key | Description | Example |
|---|---|---|
batch-uuid | Batch UUID to get delivery receipts for | ae9293fc-8af6-4dcc-87c9-c73a95b8ad49 |
Query strings
| Key | Required | Description | Example |
|---|---|---|---|
key | true | Account API key | ?key=aaaabbbbcccc111222333 |
details | false | Whether to return the details parameter in the request | ?details=true |
Response
Body
json
{
"counts": {
"total": 1,
"delivered": 1,
"failed": 0
},
}json
{
"counts": {
"total": 1,
"delivered": 1,
"failed": 0
},
"details": [
{
"destination": "+441111111111",
"delivered": true,
"failed": false,
"batchuuid": "6d26c8e8-5e58-4624-a262-2a89b4c5eae3",
"messageuuid": "7d76bd34-c8c9-4e4f-b831-d6316ffaf609",
"info": null
}
]
}json
{
"counts": {
"total": 4,
"delivered": 2,
"failed": 1
},
"details": [
{
"destination": "+441111111111",
"delivered": true,
"failed": false,
"batchuuid": "6d26c8e8-5e58-4624-a262-2a89b4c5eae3",
"messageuuid": "7d76bd34-c8c9-4e4f-b831-d6316ffaf609",
"info": null
},
{
"destination": "+442222222222",
"delivered": true,
"failed": false,
"batchuuid": "6d26c8e8-5e58-4624-a262-2a89b4c5eae3",
"messageuuid": "7d76bd34-c8c9-4e4f-b831-d6316ffaf609",
"info": null
},
{
"destination": "+443333333333",
"delivered": false,
"failed": true,
"batchuuid": "6d26c8e8-5e58-4624-a262-2a89b4c5eae3",
"messageuuid": "7d76bd34-c8c9-4e4f-b831-d6316ffaf609",
"info": null
},
{
"destination": "+444444444444",
"delivered": false,
"failed": false,
"batchuuid": "6d26c8e8-5e58-4624-a262-2a89b4c5eae3",
"messageuuid": "7d76bd34-c8c9-4e4f-b831-d6316ffaf609",
"info": null
},
]
}Body parameters
| Key | Expected value | Description |
|---|---|---|
counts.total | integer | Total number of messages in this batch |
counts.delivered | integer | Number of delivered messages in this batch |
counts.failed | integer | Number of failed messages in this batch |
details | Detail[] | Details of the messages in the batch. Only supplied if the details query string parameter is specified as true |
Detail object
| Key | Expected value | Description |
|---|---|---|
destination | string | The destination mobile number this message was sent to |
delivered | boolean | Whether this message has been marked as delivered |
failed | boolean | Whether this message as been marked as failed |
batchuuid | string | batch-uuid of this message |
messageuuid | string | message-uuid of this message |
info | Info | Info about the delivery of this batch. |
Info object
When Info gets supplied
Currently this only gets supplied in the get-delivery-receipts response if a webhook receipt endpoint was specified in the original request that generated this batch
| Key | Expected value | Description |
|---|---|---|
code | string | Hexadecimal code representing one of our internal delivery states |
description | string | Description of the error that occured during delivery |