GET api/Delivery/DeliverySummary?fd={fd}&td={td}&schoolid={schoolid}

Api to get the SMS delivery summary report for a given school and given date range

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fd

string

Required

td

string

Required

schoolid

integer

Required

Body Parameters

None.

Response Information

Resource Description

Return SMS Delivery Report

DelSummaryModel
NameDescriptionTypeAdditional information
fdate

date

None.

tdate

date

None.

nsmssent

integer

None.

nsmsdelivered

integer

None.

nsmsnotdelivered

integer

None.

nsmsexpired

integer

None.

nsmsinvalidno

integer

None.

nsmsother

integer

None.

ndlrnotfound

integer

None.

rstr

string

None.

balance_sms

string

None.

Response Formats

application/json, text/json

Sample:
{
  "fdate": "2025-10-28T10:44:10.6115662+05:30",
  "tdate": "2025-10-28T10:44:10.6115662+05:30",
  "nsmssent": 3,
  "nsmsdelivered": 4,
  "nsmsnotdelivered": 5,
  "nsmsexpired": 6,
  "nsmsinvalidno": 7,
  "nsmsother": 8,
  "ndlrnotfound": 9,
  "rstr": "sample string 10",
  "balance_sms": "sample string 11"
}

text/html

Sample:
{"fdate":"2025-10-28T10:44:10.6115662+05:30","tdate":"2025-10-28T10:44:10.6115662+05:30","nsmssent":3,"nsmsdelivered":4,"nsmsnotdelivered":5,"nsmsexpired":6,"nsmsinvalidno":7,"nsmsother":8,"ndlrnotfound":9,"rstr":"sample string 10","balance_sms":"sample string 11"}

application/xml, text/xml

Sample:
<DelSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/smsapi.Models">
  <balance_sms>sample string 11</balance_sms>
  <fdate>2025-10-28T10:44:10.6115662+05:30</fdate>
  <ndlrnotfound>9</ndlrnotfound>
  <nsmsdelivered>4</nsmsdelivered>
  <nsmsexpired>6</nsmsexpired>
  <nsmsinvalidno>7</nsmsinvalidno>
  <nsmsnotdelivered>5</nsmsnotdelivered>
  <nsmsother>8</nsmsother>
  <nsmssent>3</nsmssent>
  <rstr>sample string 10</rstr>
  <tdate>2025-10-28T10:44:10.6115662+05:30</tdate>
</DelSummaryModel>