ServicesPlatformEventsEvent types

SMS quota management

API reference

Quota information is in the event’s detail object.

SMS quota threshold reached

Remaining SMS quota volume fell below the configured threshold percentage. Exclusively for devices with enabled SMS quota management and a configured quota threshold percentage.

The threshold percentage can be submitted when the SMS quota is assigned to the device.

Example: if the device’s SMS quota volume is set to 10 SMS and the threshold percentage to 50%, the system generates an event when the remaining volume falls below 5 MB.

1{
2    "timestamp": "2021-10-27T09:21:30.000Z",
3    "alert": true,
4    "description": "SMS quota threshold reached, volume is below 50%.",
5    "id": 6734033817529352,
6    "event_type": {
7        "id": 20,
8        "description": "SMS quota threshold reached"
9    },
10    "event_source": {
11        "id": 1,
12        "description": "Policy Control"
13    },
14    "event_severity": {
15        "id": 1,
16        "description": "Warn"
17    },
18    "organisation": {
19        "id": 42139,
20        "name": "Test Org"
21    },
22    "endpoint": {
23        "id": 10991244,
24        "imei": "7345023067541287",
25        "ip_address": "121.214.125.202",
26        "name": "Factory Test Sim 2",
27        "tags": null
28    },
29    "sim": {
30        "iccid": "9097920854483458667",
31        "id": 114667,
32        "production_date": "2020-12-23T13:02:11.000Z"
33    },
34    "imsi": {
35        "id": 7940611,
36        "import_date": "2020-12-23T13:02:11.000Z",
37        "imsi": "570416925414349"
38    },
39    "detail": {
40        "quota": {
41            "volume": 0,
42            "threshold_percentage": 50,
43            "threshold_volume": 1,
44            "traffic_type": {
45                "id": 6,
46                "description": "SMS"
47            }
48        }
49    }
50}

SMS quota used up

SMS quota volume is completely depleted. Exclusively for devices with enabled SMS quota management.

Once this happens, the SMS quota status updates from Active to Exhausted, and the device won’t be able to consume from the SMS service. Established connections for that device disconnect within seconds, and new connection requests are denied until a new SMS quota is assigned or SMS quota management is disabled in the service profile.

1{
2    "timestamp": "2021-10-27T09:21:30.000Z",
3    "alert": true,
4    "description": "SMS quota volume is completely used up and SMS access denied for endpoint.",
5    "id": 896151190639914,
6    "event_type": {
7        "id": 21,
8        "description": "SMS quota used up"
9    },
10    "event_source": {
11        "id": 1,
12        "description": "Policy Control"
13    },
14    "event_severity": {
15        "id": 1,
16        "description": "Warn"
17    },
18    "organisation": {
19        "id": 63910,
20        "name": "Test Org"
21    },
22    "endpoint": {
23        "id": 98084339,
24        "imei": "7280773798507910",
25        "ip_address": "183.104.130.246",
26        "name": "Test Sim 2",
27        "tags": null
28    },
29    "sim": {
30        "iccid": "4786561754166784043",
31        "id": 2242607,
32        "production_date": "2020-12-23T13:02:11.000Z"
33    },
34    "imsi": {
35        "id": 3710068,
36        "import_date": "2020-12-23T13:02:11.000Z",
37        "imsi": "485182190937960"
38    },
39    "detail": {
40        "quota": {
41            "volume": "1.000000",
42            "threshold_percentage": 50,
43            "threshold_volume": 5,
44            "traffic_type": {
45                "id": 6,
46                "description": "SMS"
47            }
48        }
49    }
50}

SMS quota enabled

SMS quota management is enabled in a service profile.

All devices using this service profile need to have an active SMS quota assigned to use the SMS service. Devices without active SMS quotas disconnect within seconds. New connection requests are denied until a new SMS quota is assigned or SMS quota management is disabled in the service profile.

1{
2  "timestamp": "2022-07-14T13:32:54.252Z",
3  "alert": false,
4  "description": "SMS quota management enabled for service profile (id = 99133 - Generic Service Profile), endpoints of this service profile without an active SMS quota will be blocked from SMS service.",
5  "id": 503128940665149,
6  "event_type": {
7    "id": 54,
8    "description": "SMS quota enabled"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 25885,
20    "name": "Example Org"
21  }
22}

SMS quota disabled

SMS quota management is disabled in a service profile.

There’s no longer SMS service restrictions for devices using this service profile.

1{
2  "timestamp": "2022-07-14T13:33:06.602Z",
3  "alert": false,
4  "description": "SMS quota management disabled for service profile (id = 99133 - Generic Service Profile).",
5  "id": 381092102647412,
6  "event_type": {
7    "id": 55,
8    "description": "SMS quota disabled"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 6034,
20    "name": "Example Org"
21  }
22}

SMS quota assigned

New SMS quota is assigned to a device.

Assigning a new SMS quota to a device is possible at any time. SMS quota management must be enabled in the service profile.

1{
2  "timestamp": "2022-07-14T13:35:11.973Z",
3  "alert": false,
4  "description": "SMS quota assigned with volume of 10 SMS without daily refill until 2022-07-31T00:00:00Z.",
5  "id": 10526095035190,
6  "event_type": {
7    "id": 58,
8    "description": "SMS quota assigned"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 9631,
20    "name": "Example Org"
21  },
22  "endpoint": {
23    "id": 6276513,
24    "imei": "761090808370721",
25    "ip_address": "199.153.59.220",
26    "name": "Example Device",
27    "tags": null
28  },
29  "sim": {
30    "iccid": "1099167253920209804",
31    "id": 531078,
32    "production_date": "2017-05-03T20:36:28.000Z"
33  },
34  "imsi": {
35    "id": 496809,
36    "import_date": "2017-05-03T20:36:28.000Z",
37    "imsi": "19010090094479"
38  },
39  "detail": {
40    "quota": {
41      "status": {
42        "id": 1,
43        "description": "ACTIVE"
44      },
45      "action_on_exhaustion": {
46        "id": 1,
47        "description": "Block",
48        "peak_throughput": 128000
49      },
50      "volume": 10,
51      "expiryDate": "2022-07-31T00:00:00Z",
52      "lastVolumeAdded": 10,
53      "lastStatusChangeDate": "2022-07-14T13:35:11Z",
54      "autoRefill": false,
55      "thresholdPercentage": 10,
56      "thresholdVolume": 1
57    }
58  }
59}

SMS quota deleted

SMS quota is deleted from a device.

Once deleted, devices on this service profile (with SMS quota management enabled) won’t be able to use the SMS service until an active SMS quota is assigned, or SMS quota management is disabled in the service profile.

1{
2  "timestamp": "2022-07-14T13:35:22.488Z",
3  "alert": false,
4  "description": "SMS quota deleted.",
5  "id": 41270752471139,
6  "event_type": {
7    "id": 59,
8    "description": "SMS quota deleted"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 6599,
20    "name": "Example Org"
21  },
22  "endpoint": {
23    "id": 3419153,
24    "imei": "7882775753194244",
25    "ip_address": "182.112.132.120",
26    "name": "Example Device",
27    "tags": null
28  },
29  "sim": {
30    "iccid": "6587040688575397618",
31    "id": 112577,
32    "production_date": "2017-05-03T20:36:28.000Z"
33  },
34  "imsi": {
35    "id": 180774,
36    "import_date": "2017-05-03T20:36:28.000Z",
37    "imsi": "310255491186321"
38  }
39}