Delivery Report


URL:

https://api2.protexting.com/v1/sms/delivery-report?access_token=your_access_token&id=sms_id

NOTE: Delivery Report API supports only messages sent via API.  For messages sent via account dashboard, use List Sent Single Messages or List Sent Group Campaigns


Method:

GET

Response parameters:

Parameter Description
Id String
DeliveryStatus_Id Integer 
DeliveryStatus_Description String 

Example Request:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/sms/delivery-report?access_token=your_access_token&id=8cccf554cd42bf1b22bcc2d9b4e4571a4a87c9d0"

 

Example Response Headers:

Status Code: 200 OK
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Type: application/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/sms/delivery-report?access_token=your_access_token&id=8cccf554cd42bf1b22bcc2d9b4e4571a4a87c9d0>; 
rel=self Pragma: no-cache Transfer-Encoding: chunked X-Pagination-Current-Page: 1 X-Pagination-Page-Count: 1 X-Pagination-Per-Page: 100 X-Pagination-Total-Count: 1 X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-Reset: 0

Example Response Body:

[
    {
    	"Id": "8cccf554cd42bf1b22bcc2d9b4e4571a4a87c9d0",
        "DeliveryStatus_Id": "2",
"DeliveryStatus_Description":"Delivered" } ]
<response>
    <item>
    	<Id>8cccf554cd42bf1b22bcc2d9b4e4571a4a87c9d0</Id>
        <DeliveryStatus_Id><2/DeliveryStatus_Id>
<DeliveryStatus_Description>Delivered</DeliveryStatus_Description> </item> </response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

 

Delivery statuses:

Delivery Status Id Delivery Status Description
1 Pending
2 Delivered
3 Failed
4 Bufered
5 Rejected
6 Optout
7 Unknown
8  Disconected
9 Optedout 
10 Processed 
11 Retrieved 
12 Expired