API response body
{
"_meta": {
"page": 1,
"utc_endtime": "2021-01-31T23:59:59",
"utc_starttime": "2021-01-01T00:00:00",
"institution_id": "mpesa",
"user_uuid": "a1e24d28-7860-40f5-9efd-c3581fef3089",
"totalAlertsCount": 3,
"maxPage": 1,
"client_uuid": "425ff0c8-1507-4550-a8d1-b9466535afdc"
},
"alerts": [
{
"smslog_id": "c10432156ebad68e5d1ec02f68ae2a34",
"ts": 1630574902,
"smslog_body": "Failed. Insufficient funds in your M-PESA account to send KSH1,450.00, You must be able to pay the transaction fee as well as the requested amount. Your M-PESA balance is KSH1,006.65.",
"labels": [
"InsufficientFunds"
]
},
{
"smslog_id": "fb0b4e20a8c5a45a58a5b932541ac539",
"ts": 1630574899,
"smslog_body": "Failed. Insufficient funds in your M-PESA account to send KSH1,450.00, You must be able to pay the transaction fee as well as the requested amount. Your M-PESA balance is KSH1,006.65.",
"labels": [
"InsufficientFunds"
]
},
{
"smslog_id": "77afdf80daf18c700b2bcac6071888b2",
"ts": 1630574896,
"smslog_body": "Failed. Insufficient funds in your M-PESA account to send KSH1,450.00, You must be able to pay the transaction fee as well as the requested amount. Your M-PESA balance is KSH1,006.65.",
"labels": [
"InsufficientFunds"
]
}
]
}
Summary
"Alerts" are simply labelled SMS messages. See Labels here. If a SMS message qualifies for one or more labels, it is extracted as an Alert.
Sometimes, but not always, an Alert coincides with a Transaction or a Balance record. In these cases, the Alert record and the Balance/Transaction record will share the same labels.
If an Alert does not contain numerical data to extract as a Balance or a Transaction, then it is a standalone event. For example, a user might have an InsufficientFunds
Alert on a particular account. This label will appears in the Alerts, but will not appear on any Transactions or Balances of that particular account.
Fields
alerts[].smslog_id
A unique identifier for the SMS message associated with the label.
alerts[].ts
The UTC unix timestamp, in seconds, at which the alert event occurred (specifically, when the SMS was received at the mobile phone user's phone).
alerts[].smslog_body
Body of the text message that resulted in the labelled alert.
alerts[].labels[]
The labels extracted for the given sms body.