Set Auto Activation Group
Purpose
Assigns an Auto-Activation (AA) group to the specified SIM.
The group is specified using the <group> element and must be the group code, not the group name. Group codes are distributor-specific and are provided in a separate document.
By assigning an Auto-Activation group, the specified SIM will be automatically activated into the defined Live group when its test traffic allowance is exhausted.
Important conditions apply:
- The SIM must currently be in a group of type Pending If the SIM is in any other group type, the response will be Invalid ICCID.
- The Auto-Activation group specified must be of type Live If the group type is not Live, the response will be Invalid Group.
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-aa-group version="1" api-id="123456">
<authentication>
<username>username</username>
<password>password</password>
</authentication>
<iccid>1234567890123456789</iccid>
<group>group-code</group>
</set-aa-group>Response (Success)
<set-aa-group-response api-id="123456">
<api-outcome>Success</api-outcome>
</set-aa-group-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.