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

Global System for Mobile Communications Connectivity Insights Subscriptions API

Create and manage a subscription to receive periodic connectivityinsights

This API exposes 4 operations across 2 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 0.4.0.

Requests are made against a single base URL, {apiRoot}/connectivity-insights-subscriptions/v0.4/check-network-quality.

4 operations 2 paths 28 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.4.0
Server
{apiRoot}/connectivity-insights-subscriptions/v0.4/check-network-quality
Authentication
OpenID Connect, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

Global System for Mobile Communications Connectivity Insights Subscriptions API declares 2 security schemes for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration. It accepts HTTP bearer tokens ({$request.body#/sinkCredential.credentialType}) (notificationsBearerAuth).

  • openId — OpenID Provider Configuration Information
  • notificationsBearerAuth — Bearer authorization for notifications

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Connectivity Insights Subscriptions 4

Create and manage a subscription to receive periodic connectivity insights

POST
/subscriptions
Global System for Mobile Communications Create a Connectivity insights…
createSubscription 1 param body → 201202400401403409415422
GET
/subscriptions
Global System for Mobile Communications Retrieve a list of apiName event…
getSubscriptionList 1 param → 200400401403500503
GET
/subscriptions/{subscriptionId}
Global System for Mobile Communications Operation to retrieve a subscription…
getSubscription 2 params → 200400401403404500503
DELETE
/subscriptions/{subscriptionId}
Global System for Mobile Communications Operation to delete a subscription
deleteSubscription 2 params → 202204400401403404500503

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Subscription (9 properties), CloudEvent (7 properties), NetworkQualityInsight (7 properties), SubscriptionRequest (5 properties). Each schema is shown below with its type and property counts.

Source
string
Identifies the context in which an event happened, as a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-wg…
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…
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:…
SinkCredential
object
A sink credential provides authentication or authorization information
1 property 1 required
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
SubscriptionAsync
object
Response for a event-type subscription request managed asynchronously (Creation or Deletion)
1 property
SubscriptionRequest
object
The request for creating a event-type event subscription
5 properties 4 required
AdditionalKpis
object
additional information about connectivity quality
2 properties
SubscriptionId
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
Subscription
object
Represents a event-type subscription.
9 properties 6 required
PortsSpec
object
Specification of several TCP or UDP ports
2 properties
Port
integer
TCP or UDP port number
DateTime
string
Timestamp of when the occurrence happened. Must adhere to RFC 3339.
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. -…
CloudEvent
object
The Cloud-Event used for the callback.
7 properties 5 required
ErrorInfo
object
Error information
3 properties 3 required
Config
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
4 properties 1 required
CreateSubscriptionDetail
object
The detail of the requested event subscription
4 properties 2 required
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
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
ApplicationProfileId
string
Identifier for the Application Profile
PolicyFulfillmentConfidence
string
a plain-language indicator of how confident the network is to meet a given network demand.
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…
NetworkQualityInsight
object
the network's confidence level at being able to meet the network demands of a given policy for a given terminal device.
7 properties
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
EventTypeNotification
string
event-type - Event triggered when an event-type event occurred subscription-ends: Event triggered when the subscription ends
Protocol
string
Identifier of a delivery protocol. Only HTTP is allowed for now

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

global-system-for-mobile-communications-connectivity-insights-subscriptions-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Global System for Mobile Communications Connectivity Insights Subscriptions 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.