Query Fixed IP
Purpose
Returns the fixed private IP address assigned to the SIM specified in the <iccid> element.
Some customers connect their SIMs via a Virtual Private Network (VPN). In these cases, devices are addressable within a private IP address space, and a fixed private IP may be assigned to each SIM.
Typically, the fixed IP address is assigned:
- When SIMs are provisioned into the Pending group, or
- When SIMs are activated into a Live group
The exact behaviour depends on the customer’s configuration.
If a fixed IP has been assigned, it will be returned in the <fixed-ip> element.
If no fixed IP is assigned (or not yet provisioned), the response will contain an empty <fixed-ip> element.
The <fixed-ip> value is returned in standard IPv4 format.
If no fixed IP is available, the element will be present but empty.
Fixed IP allocation depends on the SIM’s provisioning and VPN configuration.
Endpoint
POST https://api.m2miportal.com
Content-Type: application/xml
Accept: application/xml
Request (XML)
<query-fixed-ip version="1" api-id="123456">
<authentication>
<username>username</username>
<password>password</password>
</authentication>
<iccid>1234567890123456789</iccid>
</query-fixed-ip>Response (Success)
<query-fixed-ip-response api-id="123456">
<api-outcome>Success</api-outcome>
<fixed-ip>10.0.0.1</fixed-ip>
</query-fixed-ip-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.