How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GSMA Roaming status retrieval API

Operation to get device roaming status and country information (if roaming) synchronously

GSMA Roaming status retrieval API is one of 31 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Roaming status retrieval. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

This API exposes 1 operation across 1 path, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 0.6.1.

Requests are made against a single base URL, {apiRoot}/device-roaming-status/v0.6.

1 operations 1 paths 14 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.6.1
Base URL
https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

GSMA Roaming status retrieval API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Roaming status retrieval 1

Operation to get device roaming status and country information (if roaming) synchronously

POST
/retrieve
Get the current roaming status and the country information
getRoamingStatus 1 param body → 200400401403404406415422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Device (4 properties), RoamingStatusResponse (4 properties), ErrorInfo (3 properties), DeviceIpv4Addr (3 properties). Each schema is shown below with its type and property counts.

ErrorInfo
object
The error object used for error-cases.
3 properties 3 required
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
LastStatusTime
string
Last time that the associated device roaming status was updated
RoamingStatusRequest
object
The request for retrieving the current roaming status for the requested device.
1 property
DeviceIpv6Address
string
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to…
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier
string
A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Loc…
ActiveRoaming
boolean
Roaming status. True, if it is roaming
CountryCode
integer
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
DeviceIpv4Addr
object
The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (o…
3 properties
Device
object
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide t…
4 properties
Port
integer
TCP or UDP port number
RoamingStatusResponse
object
4 properties 1 required
CountryName
array
The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries.…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-roaming-status-retrieval-api-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Accounts API
GSMA Authorisation Codes API
GSMA Bills API
GSMA Call Forwarding information retrieval API
GSMA Check Device Swap API
GSMA Check SIM Swap API
GSMA Debit Mandates API
GSMA Device reachability status API
GSMA Discovery API
GSMA Get Device Identifiers API
GSMA Home Devices QoD API
GSMA Links API
Where this information came from

This is an independent, third-party profile of GSMA Roaming status retrieval API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.