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 Quality-On-Demand

GSMA Quality-On-Demand from GSMA — 4 path(s) described in OpenAPI.

GSMA Quality-On-Demand is one of 18 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 29 schemas. It is described by OpenAPI 3.0.3, at version 0.11.1.

Requests are made against a single base URL, {apiRoot}/quality-on-demand/v0.11.

5 operations 4 paths 29 schemas 1 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.11.1
Base URL
https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm
Authentication
OpenID Connect, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

GSMA Quality-On-Demand 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).

  • notificationsBearerAuth — Bearer authentication for notifications

Paths & Operations 5

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

QoS Sessions 5

Manage QoS sessions

POST
/sessions
Creates a new session
createSession 1 param body → 201400401403404409422429
GET
/sessions/{sessionId}
Get QoS session information
getSession 2 params → 200400401403404429500503
DELETE
/sessions/{sessionId}
Delete a QoS session
deleteSession 2 params → 204400401403404429500503
POST
/sessions/{sessionId}/extend
Extend the duration of an active session
extendQosSessionDuration 2 params body → 200400401403404409429500
POST
/retrieve-sessions
Get QoS session information for a device
retrieveSessionsByDevice 1 param body → 200400401403404422429500

Schemas 29

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

SessionId
string
Session ID in UUID format
BaseSessionInfo
object
Common attributes of a QoD session
7 properties 2 required
SessionInfo
Session related information returned in responses. Note that the device object is defined as optional and will only to be returned if provided in createSession…
CreateSession
Attributes required to create a session
Port
integer
TCP or UDP port number
PortsSpec
object
Specification of several TCP or UDP ports
2 properties
SinkCredential
object
1 property 1 required
PlainCredential
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential
object
An access token credential.
RefreshTokenCredential
object
An access token credential with a refresh token.
5 required
ExtendSessionDuration
object
Attributes required to extend the duration of an active session
1 property 1 required
QosProfileName
string
A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options address…
CloudEvent
object
Event compliant with the CloudEvents specification
7 properties 5 required
EventQosStatusChanged
Event to notify a QoS status change
StatusInfo
string
Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'. DURATIONEXPIRED - Session terminated due to requested du…
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
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
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…
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
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
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…
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:…
QosStatus
string
The current status of the requested QoS session. The status can be one of the following: REQUESTED - QoS has been requested by creating a session AVAILABLE - T…
EventQosStatus
string
The current status of a requested or previously available session. Applicable values in the event are: AVAILABLE - The requested QoS has been provided by the n…
ErrorInfo
object
Common schema for errors
3 properties 3 required
RetrieveSessionsInput
object
Parameters to get QoS session information by device
1 property
RetrieveSessionsOutput
array
QoS session information for a given device

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-open-gateway-quality-on-demand-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Mobile Money API
GSMA Call Forwarding Signal
GSMA Carrier Billing
GSMA Carrier Billing Refund
GSMA CAMARA Mobile Device Identifier
GSMA Device Location Retrieval
GSMA Device Location Verification
GSMA Device Reachability Status
GSMA Device Roaming Status
GSMA Device Swap
GSMA Home Devices QoD
GSMA Know Your Customer Match
Where this information came from

This is an independent, third-party profile of GSMA Quality-On-Demand, 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.