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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

CAMARA Project

CAMARA Project QoS Sessions API

Manage QoS sessions

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 5 operations across 4 paths, and defines 26 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.

5 operations 4 paths 26 schemas 1 DELETE1 GET3 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
Apache 2.0
Resource Areas
1

Authentication & Security 1

CAMARA Project QoS Sessions 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 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 → 200400401403404429
DELETE
/sessions/{sessionId}
Delete a QoS session
deleteSession 2 params → 204400401403404429
POST
/sessions/{sessionId}/extend
Extend the duration of an active session
extendQosSessionDuration 2 params body → 200400401403404409429
POST
/retrieve-sessions
Get QoS session information for a device
retrieveSessionsByDevice 1 param body → 200400401403404422429

Schemas 26

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

StatusInfo
string
Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'. DURATIONEXPIRED - Session terminated due to requested du…
QosProfileName
string
A unique name for identifying a specific QoS profile. This may follow different formats depending on the API provider implementation. Some options addresses: -…
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…
CloudEvent
object
Event compliant with the CloudEvents specification
7 properties 5 required
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
RetrieveSessionsOutput
array
QoS session information for a given device
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…
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…
CreateSession
Attributes required to create a session
BaseSessionInfo
object
Common attributes of a QoD session
6 properties 2 required
XCorrelator
string
Value for the x-correlator
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 API consumer can choose to provide the below specified device identifiers:…
2 properties
ExtendSessionDuration
object
Attributes required to extend the duration of an active session
1 property 1 required
ErrorInfo
object
Common schema for errors
3 properties 3 required
SinkCredential
object
1 property 1 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…
SessionId
string
Session ID in UUID format
Port
integer
TCP or UDP port number
Device
object
End-user equipment able to connect to a network. Examples of devices include smartphones or IoT sensors/actuators. The API consumer can choose to provide the b…
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:…
RetrieveSessionsInput
object
Parameters to get QoS session information by device
1 property
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-qos-sessions-api-openapi.yml Raw ↑

Other APIs CAMARA Project publishes across the network.

CAMARA Project Age Verification API
AE Profile APIs.io
CAMARA Project Call Forwarding information retrieval API
AE Profile APIs.io
CAMARA Project Check Device Swap API
AE Profile APIs.io
CAMARA Project Check SIM swap API
AE Profile APIs.io
CAMARA Project Connected Network Type API
AE Profile APIs.io
CAMARA Project Device reachability status API
AE Profile APIs.io
CAMARA Project Discovery API
AE Profile APIs.io
CAMARA Project Fill-in API
AE Profile APIs.io
CAMARA Project Geofencing subscriptions API
AE Profile APIs.io
CAMARA Project Home Devices QoD API
AE Profile APIs.io
CAMARA Project Location retrieval API
AE Profile APIs.io
CAMARA Project Location verification API
AE Profile APIs.io
#QoS Sessions
← Back to C APIs
API Details
ID
camara-project:camara-project-qos-sessions-api
Server
{apiRoot}/call-forwarding-signal/vwip
Docs
https://github.com/camaraproject/NumberVerification
Provider
CAMARA Project
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network