Query Group
4 min
Purpose
Returns the group code for the specified SIM.
The group returned is the group code, not the group name. Available groups and group codes are distributor-specific and are provided in a separate document.
Endpoint
POST https://api.m2miportal.com
Content-Type: application/xml
Accept: application/xml
Request (XML)
<query-group version="1" api-id="123456">
<authentication>
<username>username</username>
<password>password</password>
</authentication>
<iccid>1234567890123456789</iccid>
</query-group>Response (Success)
<query-group-response api-id="123456">
<api-outcome>Success</api-outcome>
<group>group-code</group>
</query-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.