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 Open Gateway Device reachability status subscription API

Operation to manage event subscription on device reachability status event.

GSMA Open Gateway Device reachability status subscription API is one of 34 APIs that GSMA Open Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Device reachability status subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against a single base URL, {apiRoot}/device-reachability-status-subscriptions/v0.8.

4 operations 2 paths 22 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.8.0
Server
{apiRoot}/device-reachability-status-subscriptions/v0.8
Authentication
OpenID Connect, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

GSMA Open Gateway Device reachability status subscription 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).

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.

Device reachability status subscription 4

Operation to manage event subscription on device reachability status event.

POST
/subscriptions
Create a device reachability status event subscription for a device
createDeviceReachabilityStatusSubscription 1 param body → 201202400401403409422429
GET
/subscriptions
Retrieve a list of device reachability status event subscription
retrieveDeviceReachabilityStatusSubscriptionList 1 param → 200400401403
GET
/subscriptions/{subscriptionId}
Retrieve a device reachability status event subscription for a device
retrieveDeviceReachabilityStatusSubscription 2 params → 200400401403404
DELETE
/subscriptions/{subscriptionId}
Delete a device reachability status event subscription for a device
deleteDeviceReachabilityStatusSubscription 2 params → 204202400401403404

Schemas 22

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

EventTypeNotification
string
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability). reachability-sms - Event t…
Protocol
string
Identifier of a delivery protocol. Only HTTP is allowed for now
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
CloudEvent
object
The notification callback
7 properties 5 required
XCorrelator
string
SubscriptionAsync
object
Response for a device reachability status operation managed asynchronously (Creation or Deletion)
1 property 1 required
DateTime
string
Timestamp of when the occurrence happened. If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the cu…
Subscription
object
Represents a event-type subscription.
8 properties 5 required
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…
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…
SinkCredential
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property 1 required
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
SubscriptionEventType
string
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability). reachability-sms - Event t…
ErrorInfo
object
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…
CreateSubscriptionDetail
object
The detail of the requested event subscription.
1 property
SubscriptionRequest
object
The request for creating a event-type event subscription
5 properties 4 required
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
Source
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-gateway-device-reachability-status-subscription-api-openapi.yml Raw ↑

Other APIs GSMA Open Gateway publishes across the network.

GSMA Open Gateway Age Verification API
GSMA Open Gateway API Product API
GSMA Open Gateway API Product Order API
GSMA Open Gateway Application API
GSMA Open Gateway Application Owner API
GSMA Open Gateway Call Forwarding information retrieval API
GSMA Open Gateway Check Device Swap API
GSMA Open Gateway Check SIM swap API
GSMA Open Gateway Check Subscriber Tenure API
GSMA Open Gateway Connected Network Type API
GSMA Open Gateway Device reachability status API
GSMA Open Gateway Discovery API
Where this information came from

This is an independent, third-party profile of GSMA Open Gateway Device reachability status subscription 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.