Set Status
Purpose
Sets the SIM status to either Active or De-activated.
This operation does not change the SIM’s group and therefore does not affect monthly tariffs. It can be used to prevent or allow traffic sessions on the mobile device within the bounds of the current group.
The target device is specified using the <iccid> element. The new status is specified using the <status> element.
Valid values for <status> are:
- active
- de-activated
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/xmlRequest (XML)
<set-status version="1" api-id="123456">
<authentication>
<username>username</username>
<password>password</password>
</authentication>
<iccid>1234567890123456789</iccid>
<status>active</status>
</set-status>Response (Success)
<set-status-response api-id="123456">
<api-outcome>Success</api-outcome>
</set-status-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.