Bundle Monitor
Bundle Monitor is Cellhire's usage alerting solution, custom definitions can be setup to alert yourself or customers of usage over a certain threshold.
Network Support
- SIM status must be "on-hire"
- All SIMs must be:
- On the same network
- On the same account
| Network | NetworkId | Configure Bundle Monitor | Admin Barring | GPRS (Data) Barring |
|---|---|---|---|---|
| eSIMsmart | 218 | ✓ | ✓ | X |
| eSIMsmart IOT | 225 | ✓ | ✓ | X |
| MT-IOT M2MO | 232 | ✓ | ✓ | ✓ |
| MT-IOT M2MV | 233 | ✓ | ✓ | ✓ |
| O2 (UK) | 24 | ✓ | ✓ | ✓ |
| O2 (USA) (UK) | 29 | ✓ | ✓ | ✓ |
| O2 (World) | 97 | ✓ | ✓ | ✓ |
| O2 AT (UK) | 195 | ✓ | ✓ | ✓ |
| Orange (France) | 192 | ✓ | ✓ | X |
| Orange (France) LMVNO | 234 | ✓ | ✓ | X |
| Vodafone (UK) | 3 | ✓ | ✓ | ✓ |
| Vodafone PPM (UK) | 141 | ✓ | ✓ | ✓ |
| Vodafone SB (UK) | 151 | ✓ | ✓ | ✓ |
| Vodafone M2M (UK) | 164 | ✓ | ✓ | ✓ |
| Vodafone BA (UK) | 168 | ✓ | ✓ | ✓ |
| Vodafone AT (UK) | 200 | ✓ | ✓ | ✓ |
Configure Bundle Monitor
Request Payload Constraints:
| Property | Constraints |
|---|---|
| name | Optional, Max length of 200 characters. |
| serialNumbers | Must provide atleast one |
| startDate | Must be greater than 1 month in the past and less than 1 month in the future. |
| bundlePeriodUnit | Must be either "day" or "month". |
| bundlePeriodValue | Must be greater than 0 and less than 32. |
| bundleSize | Must be greater than 0 and less than 10485761. |
| unbar | Must respect the available barring options based on the SIMs network. |
| notifications | If provided, must respect notification constraints (see below). |
Notification Constraints:
| Property | Constraints |
|---|---|
| type | Must be either "warning" or "alert". |
| deliveryType | Must be either "sms" or "email". |
| recipients | If deliveryType is "sms", must be a valid list of MSISDNs* unless notifySimsOwnTelephoneNumber is True. If deliveryType is "email", must be a valid list of email addresses**. |
| volumePercentage | Must be greater than 0 and less than 101. |
| notifySimsOwnTelephoneNumber | If deliveryType is "sms" and no recipients provided, must be True. |
| bar | Must respect the available barring options based on the SIMs network. (Admin or GPRS) |
*Example sms recipients (semi-colon separated): "07123456789; 07987654321"
**Example email recipients (semi-colon separated): "test1@cellhire.com; test2@cellhire.com; test3@cellhire.com"
Example Request
curl --location 'https://api.cellhire.com/api/simSubmission/ConfigureBundleMonitor' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"name": "test submission",
"serialNumbers": ["89441000303198729483"],
"startDate": "2024-06-01T00:00:00.000Z",
"bundlePeriodUnit": "month",
"bundlePeriodValue": 1,
"bundleSize": 250,
"unbar": { "admin": true, "gprs": true },
"notifications": [
{
"type": "warning",
"deliveryType": "email",
"recipients": "test@cellhire.com",
"volumePercentage": 25,
"notifySimsOwnTelephoneNumber": false,
"bar": { "admin": false, "gprs": false }
},
{
"type": "alert",
"deliveryType": "email",
"recipients": "test@cellhire.com",
"volumePercentage": 75,
"notifySimsOwnTelephoneNumber": false,
"bar": { "admin": true, "gprs": true }
}
]
}Remove Bundle Monitor
Request Payload Constraints:
| Property | Constraints |
|---|---|
| name | Max length of 200 characters. |
| serialNumbers | Must supply atleast one |
Example Request
curl --location 'https://api.cellhire.com/api/simSubmission/RemoveBundleMonitor' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"name": "test submission",
"serialNumbers": ["89441000303198729483"]
}