Using Our APIs
Commands
Set Usage Levels
7 min
purpose sets monitoring levels for sim usage when a sim reaches the warning level, an email notification is sent to the addresses registered with support when a sim reaches the limit level, another email is sent and traffic for the sim is disabled note if changing the levels immediately places the sim into a warning or cut off condition, the corresponding actions will occur as a result of this request conditions and rules usage levels can only be set for sims in live groups attempts to set levels for sims in pending or suspended groups will return invalid iccid if either \<warning> or \<limit> is omitted, the existing value for the omitted element will remain unchanged, except \<limit> must be greater than or equal to \<warning> if this is not the case, both warning and limit will be set to the \<warning> value setting usage levels for pre paid sims is not allowed and will return invalid iccid meaning of values the meaning of the values supplied depends on the sim type manx telecom sims (1 net, multinet voda, multinet m2m, smart o2 voda) values represent the nominal balance in £ example \<warning>10\</warning> triggers a warning when the nominal balance reaches £10 00 other sim types (multinet kpn c, kpn o, kpn lbs, ee, o2 uk, multinet rog c, 3 global, verizon, verizon m1, tele2) values represent data usage in mb example \<limit>20\</limit> triggers cut off when usage reaches 20 mb discrete usage levels values must match one of the supported discrete steps below if a value does not match one of these steps, the response will be invalid content usage level api value 1 mb 1 1 5 mb 1 5 2 mb 2 3 mb 3 4 mb 4 5 mb 5 6 mb 6 7 mb 7 8 mb 8 10 mb 10 12 mb 12 15 mb 15 20 mb 20 25 mb 25 30 mb 30 40 mb 40 50 mb 50 60 mb 60 70 mb 70 80 mb 80 100 mb 100 120 mb 120 150 mb 150 200 mb 200 250 mb 250 300 mb 300 400 mb 400 500 mb 500 600 mb 600 700 mb 700 800 mb 800 1 gb 1024 1 5 gb 1536 2 gb 2048 2 5 gb 2560 3 gb 3072 4 gb 4096 5 gb 5120 6 gb 6144 7 gb 7168 8 gb 8192 10 gb 10240 15 gb 15360 20 gb 20480 30 gb 30720 40 gb 40960 50 gb 51200 60 gb 61440 70 gb 71680 80 gb 81920 100 gb 102400 150 gb 153600 200 gb 204800 250 gb 256000 400 gb 409600 500 gb 512000 800 gb 819200 1 tb 1048576 2 tb 2097152 5 tb 5242880 operational impact api commands perform live configuration changes changes take effect immediately commands may affect sim status, service availability, charging, or usage limits requests cannot be undone automatically ensure all parameters are validated before submitting requests to the production environment endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<set usage levels version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \<warning>100\</warning> \<limit>500\</limit> \</set usage levels> response (success) \<set usage levels response api id="123456"> \<api outcome>success\</api outcome> \</set usage levels response> response (failure) if a request cannot be processed, the response will include api outcome indicating failure an error description explaining the reason failure responses may occur due to invalid authentication credentials invalid or unknown identifiers (for example iccid or msisdn) invalid or missing parameters values not permitted for the specified sim type or account configuration insufficient permissions integrating systems should validate input data before submission and implement appropriate error handling and logging