To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Summary statistics for SMS messages sent by an account, covering total volume, total cost and delivery success rate. Built from aggregated SmsItem counts and totals for use in reporting and admin views.
Properties
| Property | Returns | Description |
|---|---|---|
| currency | String | The currency code that getTotalCost is denominated in. |
| deliveredOk | long | The number of messages in this summary that were confirmed delivered. |
| deliveryRatePerc | Integer | The proportion of messages confirmed delivered, as a whole-number percentage of the total. |
| total | long | The total number of SMS messages counted in this summary. |
| totalCost | long | The total cost of the messages in this summary, in the currency returned by getCurrency. |
Methods
getTotal()
Returns: long
The total number of SMS messages counted in this summary.
getCurrency()
Returns: String
The currency code that getTotalCost is denominated in.
getTotalCost()
Returns: long
The total cost of the messages in this summary, in the currency returned by getCurrency.
getDeliveredOk()
Returns: long
The number of messages in this summary that were confirmed delivered.
getDeliveryRatePerc()
Returns: Integer
The proportion of messages confirmed delivered, as a whole-number percentage of the total.
© 2025 Kademi Ltd