SMS DeliveryReceipt Events

Current

URI Method Description 
/ids-data-api/v1/sms-dr-events/current/{deviceId}
 GET This API retrieves the most recent SMS Delivery Receipt events of the specified device.

Method: GET

URI: 

http://impactids-edge-01/ids-data-api/v1/sms-dr-events/current/352253064335022
Response: 200 OK:
[
    {
        "groupName": "auto1",
        "deviceId": "352253064335022",
        "serverTime": "2019-02-04T11:42:52.040+00:00",
        "imsi": "352253064335022",
        "subscriberId": "as45-45j",
        "requestId": "1001",
        "status": "DELIVERED",
        "frames": [
            {
                "lastUpdated": "1549280572040",
                "requestId": "1001",
                "smscInstance": "testsmsc",
                "smscMsgId": "1",
                "status": "DELIVERED"
            },
            {
                "lastUpdated": "1549280572051",
                "requestId": "1001",
                "smscInstance": "testsmsc",
                "smscMsgId": "2",
                "status": "DELIVERED"
            }
        ]
    }
]

Historical

URI Method Description 
/ids-data-api/v1/sms-dr-events/history?fromTime=<fromTime>&toTime=<toTime>&deviceId=<deviceIds>&requestId=<requestIds>&status=<statuses>
 GET This API retrieves all the SMS Delivery Receipt events for specified devices in the specified time range. Multiple requestIds and statuses can be specified to filter out events.

Method: GET

URI: 

http://impactids-edge-01/ids-data-api/v1/sms-dr-events/history?fromTime=2000-01-01T00:00:00&toTime=2021-12-01T00:00:00&deviceId= 352253064335022&status=DELIVERED&requestId=1001
Response: 200 OK:
[
    {
        "groupName": "auto1",
        "deviceId": "352253064335022",
        "serverTime": "2019-02-04T11:42:52.040+00:00",
        "imsi": "352253064335022",
        "subscriberId": "as45-45j",
        "requestId": "1001",
        "status": "DELIVERED",
        "frames": [
            {
                "lastUpdated": "1549280572040",
                "requestId": "1001",
                "smscInstance": "testsmsc",
                "smscMsgId": "1",
                "status": "DELIVERED"
            },
            {
                "lastUpdated": "1549280572051",
                "requestId": "1001",
                "smscInstance": "testsmsc",
                "smscMsgId": "2",
                "status": "DELIVERED"
            }
        ]
    }
]

Bulk

URI Method Description 
/ids-data-api/v1/sms-dr-events/bulk?fromTime=<fromTime>&toTime=<toTime>
 GET This API retrieves SMS Delivery Receipt events of all the devices in the specified time range.The response consists of a list of JSON formatted data, separated by newlines.

Method: GET

URI: 

http://impactids-edge-01/ids-data-api/v1/sms-dr-events/bulk?fromTime=2019-01-01T00:00:00&toTime=2023-03-28T00:00:00
Response: 200 OK:
{
"groupName": "auto1",
"deviceId": "352253064335022",
"serverTime": 1549280572040,
"imsi": "352253064335022",
"subscriberId": "as45-45j",
"requestId": "1001",
"status": "DELIVERED",
"frames": [{
"lastUpdated": "1549280572040",
"requestId": "1001",
"smscInstance": "testsmsc",
"smscMsgId": "1",
"status": "DELIVERED"
}, {
"lastUpdated": "1549280572051",
"requestId": "1001",
"smscInstance": "testsmsc",
"smscMsgId": "2",
"status": "DELIVERED"
}]
}