{"_id":"5829d6914dd20b0f0085d983","parentDoc":null,"project":"54eb50e5615ffc1900305a16","__v":0,"user":"57a98d832242630e00cc8df7","version":{"_id":"54eb63b859b1172100334fae","project":"54eb50e5615ffc1900305a16","forked_from":"54eb63a1867e1917009b711d","__v":26,"createdAt":"2015-02-23T17:30:32.501Z","releaseDate":"2015-02-23T17:30:32.501Z","categories":["54eb63b959b1172100334faf","54eb63b959b1172100334fb0","54eb63b959b1172100334fb1","54eb63b959b1172100334fb2","54ed8dd4ab373e2300f50eae","54ed99b2ab373e2300f50ede","55153a6de68daa2f00cff838","551546edbc466623002afe72","5515472ac28d6125001b8884","55154749c28d6125001b8885","555d9b4106dfec0d00d38ea7","5613e06e433e5735007c7708","5624bbb785a31117001c5403","56669e857cc81e0d00253f8e","568b8d837a42220d00498311","56a632277ef6620d00e2f18a","56d8147c3eb4dd0b00201aac","57a9ce2fac6db30e000d7efd","57a9cf4e944ea60e00dc3f74","58172386715dce0f00da4aa0","582dc59ee1b8692300c0dd03","589b19b4fec2730f0082e040","58b04a023529383900a759b5","58b92d1598157a0f004869bf","592e7685c58275000f20174f","59392839e376d4002f8a0474","59393064e376d4002f8a05a1","5947ae0d4005e2000f3a4fec","594a74df1d1de5001ab3517a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"58172386715dce0f00da4aa0","project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-10-31T10:57:10.541Z","from_sync":false,"order":14,"slug":"facebook-messages","title":"Facebook messenger"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-14T15:21:53.586Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"name":"","code":"{\n  \"results\":[  \n    {\n      \"messageId\":\"ff4804ef-6ab6-4abd-984d-ab3b1387e852\",\n      \"to\":\"37512FEC78DBC1895567B09AE6D9439328C12E83BC83D449BC4A9F32F1AE3C3A\",\n      \"sentAt\":\"2015-02-12T09:58:20.323+0100\",\n      \"doneAt\":\"2015-02-12T09:58:20.337+0100\",\n      \"messageCount\":1,\n      \"price\":{  \n      \t\"pricePerMessage\":0.01,\n        \"currency\":\"EUR\"\n      },\n      \"status\":{  \n      \t\"id\":5,\n        \"groupId\":3,\n        \"groupName\":\"DELIVERED\",\n        \"name\":\"DELIVERED_TO_HANDSET\",\n        \"description\":\"Message delivered to handset\"\n\t\t\t},\n      \"error\":{  \n      \t\"groupId\":0,\n        \"groupName\":\"OK\",\n        \"id\":0,\n        \"name\":\"NO_ERROR\",\n        \"description\":\"No Error\",\n        \"permanent\":false\n      },\n      \"channel\": \"FACEBOOK\"\n    }\n  ]\n}","language":"json"}]},"settings":"","examples":{"codes":[{"name":"","code":"GET /facebook/1/reports HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nAccept: application/json","language":"json"}]},"auth":"required","params":[{"_id":"55191d11337285170047f853","ref":"","in":"query","required":false,"desc":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a [multiple push messages](http://dev.infobip.com/v1/docs/send-multiple-push).","default":"","type":"string","name":"bulkId"},{"_id":"55191d11337285170047f852","ref":"","in":"query","required":false,"desc":"The ID that uniquely identifies the sent message.","default":"","type":"string","name":"messageId"},{"_id":"55191d11337285170047f84e","ref":"","in":"query","required":false,"desc":"The max number of messages in returned reports. Default value is **50**.","default":"","type":"int","name":"limit"}],"url":"/facebook/:version/reports"},"isReference":false,"order":3,"body":"# Response format\n\nIf successful, response header HTTP status code will be `200 OK` and delivery reports will be returned.\n\nIf you try to get delivery reports without authorization, you will get a response with HTTP status code `401 Unauthorized`.\n\n## ReportsResponse\n\n|Parameter|Type|Description|\n|-|-|-|\n|*results*|[Report[]](#section-report)|Collection of reports, one per every message.|\n\n### Report\n\n|Parameter|Type|Description|\n|-|-|-|\n|*messageId*|String|The ID that uniquely identifies the message sent.|\n|*to*|String|The message destination address.|\n|*sentAt*|Date|Tells when the message was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.|\n|*doneAt*|Date|Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.)|\n|*messageCount*|int|The number of sent message segments.|\n|*price*|[Price](#section-price)|Sent message price.|\n|*status*|[Status](#section-status)|Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.|\n|*error*|[Error](#section-error)|Indicates whether the error occurred during the query execution.|\n\n#### Price\n\n|Parameter|Type|Description|\n|-|-|-|\n|*pricePerMessage*|BigDecimal|Price per message.|\n|*currency*|String|The currency in which the price is expressed.|\n\n#### Status\n\n|Parameter|Type|Description|\n|-|-|-|\n|*groupId*|int|Status [group ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*groupName*|String|Status [group name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*id*|int|Status [ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*name*|String|Status [name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#status-object-example) of the status.|\n|*action*|String|[Action](http://dev.infobip.com/v1/docs/response-codes#status-object-example) that should be taken to eliminate the error.|\n\n#### Error\n\n|Parameter|Type|Description|\n|-|-|-|\n|*groupId*|int|Error [group ID](http://dev.infobip.com/v1/docs/response-codes#error-object-example).|\n|*groupName*|String|Error [group name](http://dev.infobip.com/v1/docs/response-codes#error-object-example).|\n|*id*|int|Error [ID](http://dev.infobip.com/v1/docs/response-codes#error-object-example).|\n|*name*|String|Error [name](http://dev.infobip.com/v1/docs/response-codes#error-object-example).|\n|*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#error-object-example) of the error.|\n|*permanent*|boolean|Tells if the error [is permanent](http://dev.infobip.com/v1/docs/response-codes#error-object-example).|","excerpt":"This method allows you to get one time delivery reports for sent messages","slug":"facebook-messenger-delivery-reports","type":"endpoint","title":"Delivery reports"}

getDelivery reports

This method allows you to get one time delivery reports for sent messages

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

bulkId:
string
The ID that uniquely identifies the request. Bulk ID will be received only when you send a [multiple push messages](http://dev.infobip.com/v1/docs/send-multiple-push).
messageId:
string
The ID that uniquely identifies the sent message.
limit:
integer
The max number of messages in returned reports. Default value is **50**.

Examples


Result Format


Documentation

# Response format If successful, response header HTTP status code will be `200 OK` and delivery reports will be returned. If you try to get delivery reports without authorization, you will get a response with HTTP status code `401 Unauthorized`. ## ReportsResponse |Parameter|Type|Description| |-|-|-| |*results*|[Report[]](#section-report)|Collection of reports, one per every message.| ### Report |Parameter|Type|Description| |-|-|-| |*messageId*|String|The ID that uniquely identifies the message sent.| |*to*|String|The message destination address.| |*sentAt*|Date|Tells when the message was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.| |*doneAt*|Date|Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.)| |*messageCount*|int|The number of sent message segments.| |*price*|[Price](#section-price)|Sent message price.| |*status*|[Status](#section-status)|Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.| |*error*|[Error](#section-error)|Indicates whether the error occurred during the query execution.| #### Price |Parameter|Type|Description| |-|-|-| |*pricePerMessage*|BigDecimal|Price per message.| |*currency*|String|The currency in which the price is expressed.| #### Status |Parameter|Type|Description| |-|-|-| |*groupId*|int|Status [group ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*groupName*|String|Status [group name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*id*|int|Status [ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*name*|String|Status [name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#status-object-example) of the status.| |*action*|String|[Action](http://dev.infobip.com/v1/docs/response-codes#status-object-example) that should be taken to eliminate the error.| #### Error |Parameter|Type|Description| |-|-|-| |*groupId*|int|Error [group ID](http://dev.infobip.com/v1/docs/response-codes#error-object-example).| |*groupName*|String|Error [group name](http://dev.infobip.com/v1/docs/response-codes#error-object-example).| |*id*|int|Error [ID](http://dev.infobip.com/v1/docs/response-codes#error-object-example).| |*name*|String|Error [name](http://dev.infobip.com/v1/docs/response-codes#error-object-example).| |*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#error-object-example) of the error.| |*permanent*|boolean|Tells if the error [is permanent](http://dev.infobip.com/v1/docs/response-codes#error-object-example).|

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}