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 Network Quality API

Read the network's level of confidence that it can meet the qualitythresholds for a given application profile and end user device.

CAMARA Project Network Quality 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 Network Quality. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 20 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 20 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 Network Quality 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.

Network Quality 1

Read the network's level of confidence that it can meet the quality thresholds for a given application profile and end user device.

POST
/check-network-quality
Check the network quality.
checkNetworkQuality 1 param body → 200400401403404422429

Schemas 20

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

ApplicationProfileId
string
Identifier for the Application Profile
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
NetworkQualityInsightResponse
object
the network's confidence level at being able to meet the network demands of a given application for a given terminal device.
6 properties
DeviceResponse
An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer incl…
AdditionalKpis
object
additional information about connectivity quality
2 properties
DeviceResponseBody
object
The optional device identifier to include in the response
1 property
XCorrelator
string
NetworkQualityInsightRequest
object
request body to query the network quality for a given device and application profile
5 properties
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
ApplicationServer
object
A server hosting backend applications to deliver some business logic to clients. The developer can choose to provide the below specified device identifiers: ip…
2 properties
ErrorInfo
object
Error information
3 properties 3 required
PortsSpec
object
Specification of several TCP or UDP ports
2 properties
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…
NetworkQualityThresholdsConfidence
string
a plain-language indicator of how confident the network is to meet a given network demand.
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
ApplicationServerIpv4Address
string
IPv4 address may be specified in form as: - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. -…
ApplicationServerIpv6Address
string
IPv6 address may be specified in form as: - address - The /128 subnet is optional for single addresses: - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - 2001:db8:85a3:…
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-network-quality-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