Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CAMARA Project Roaming status retrieval API

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

CAMARA Project Roaming status retrieval API is one of 30 APIs that CAMARA Project 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 and API documentation.

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

Requests are made against a single base URL, {apiRoot}/call-forwarding-signal/vwip.

1 operations 1 paths 14 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
wip
Server
{apiRoot}/call-forwarding-signal/vwip
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

CAMARA Project 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.

  • openId — to support Consent Management

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 → 200400401403404422429503

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.

ActiveRoaming
boolean
Roaming status. True, if it is roaming
LastStatusTime
string
Last time that the associated device roaming status was updated
CountryCode
integer
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
RoamingStatusResponse
object
4 properties 1 required
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
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
ErrorInfo
object
The error object used for error-cases.
3 properties 3 required
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…
RoamingStatusRequest
object
The request for retrieving the current roaming status for the requested device.
1 property
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.…
Port
integer
TCP or UDP port number
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
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-roaming-status-retrieval-api-openapi.yml Raw ↑

Other APIs CAMARA Project publishes across the network.

CAMARA Project Age Verification API
CAMARA Project Call Forwarding information retrieval API
CAMARA Project Check Device Swap API
CAMARA Project Check SIM swap API
CAMARA Project Connected Network Type API
CAMARA Project Device reachability status API
CAMARA Project Discovery API
CAMARA Project Fill-in API
CAMARA Project Geofencing subscriptions API
CAMARA Project Home Devices QoD API
CAMARA Project Location retrieval API
CAMARA Project Location verification API