Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Report

Get DLR consolidated report

Retrieves delivery receipt reports from Elasticsearch. Supports scroll-based pagination.

Initial request: Provide feed_id, from_date, and to_date. The response includes a scroll_id if more data is available.

Pagination: Pass the scroll_id from the previous response to fetch the next page. No other parameters are needed when scrolling.

End of data: When the last page is reached, scroll_id is omitted from the response. If scrolled past the end, data returns as an empty array.

Constraints:

  • Date range must not exceed 31 days.
  • from_date must not be after to_date.
  • All requested feed_id values must belong to the authenticated user.
get/v1/report/dlr-consolidated-report

Query parameters

feed_idstring

Comma-separated feed IDs. Required for initial search; not needed when using scroll_id.

from_datestring date

Start date in YYYY-MM-DD format. Required for initial search.

to_datestring date

End date in YYYY-MM-DD format. Required for initial search.

scroll_idstring

Scroll ID from a previous response to fetch the next page. When provided, all other parameters are ignored.

ent_idinteger

Enterprise ID filter

delivery_statusstring

Filter by delivery status (e.g., DELIVRD, FAILED)

sender_idstring

Filter by sender ID

mobile_numberstring

Filter by mobile number (digits only)

request_idinteger

Filter by request ID

Response

DLR report data

status'success' | 'failure' required
messagestring

Present only on failure

scroll_idstring

Scroll ID for fetching the next page. Omitted when no more data is available.

Example response

{
  "status": "success",
  "scroll_id": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZX...",
  "data": [
    {
      "mobile_no": "919876543210",
      "request_id": 17735018747,
      "sender_id": "TESTSM",
      "dlt_template_id": 1107161234567,
      "feed_name": "TestFeed1",
      "message": "Dear Customer, your OTP is 123456. Valid for 10 minutes.",
      "operator": "Airtel",
      "circle": "Delhi",
      "requested_on": "2026-01-12 10:15:30",
      "last_activity": "2026-01-12 10:15:35",
      "status": "DELIVRD",
      "sms_count": 1,
      "tag": "campaign_jan",
      "transaction_id": 90001,
      "message_type": "Text"
    }
  ]
}