device-reachability-status-subscriptions
openapi: 3.0.3
info:
title: Device Reachability Status Subscriptions
description: |
This API provides the API consumer with the ability to subscribe to Reachability status events.
API consumer is able to be notified whether the reachability status of a certain user device has changed to either data- or sms-usage.
This capability is provided via a subscription request - in this case the reachability situation is part of the event notification, which is sent back to the event subscriber when reachability situation has changed.
* **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.
At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
The API exposes following capability:
These endpoints allow to manage event subscription on reachability device status event.
The CAMARA subscription model is detailed in the CAMARA API design guideline document and follows CloudEvents specification.
When subscribing, it is mandatory to provide the event `types` you are subscribing to, as multiple subscription-types are managed by this API.
Following event ``types`` are managed for this API:
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data``: Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms``: Event triggered when the device is connected to the network only for SMS usage
- ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected``: Event triggered when the device is not connected.
Note: Additionally to these list, ``org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends`` notification `type` is sent when the subscription ends.
This notification does not require dedicated subscription.
It is used in following cases:
- the subscription expire time (optionally set by the requester) has been reached
- the maximum number of subscription events (optionally set by the requester) has been reached
- the subscription was deleted by the requester
- the Access Token `sinkCredential` (optionally set by the requester) expiration time has been reached
- the API server has to stop sending notification prematurely
**Note on combined usage of ``initialEvent`` and ``subscriptionMaxEvents``**:
If an event is triggered following ``initialEvent`` set to true,
this event will be counted towards ``subscriptionMaxEvents`` (if provided).
**Clarification on ``initialEvent`` & ``event-type`` behaviour:**
Following table illustrate behaviour regarding event triggering depending on **initial** reachability state of the device:
| subscribed event-type | device reachability status at subscription time | event sent if ``initialEvent`` set to true | Explanation |
| ----------------------| ------------- | --------------- | ---------------|
| reachability-data | Device can use data | Yes | The device is reachable for data, so the event is triggered. |
| reachability-data | Device is disconnected or SMS-only | No | The device cannot use data, so no event is sent. |
| reachability-sms | Device can use data | No | The device can use data, but for thids event is only for SMS. |
| reachability-sms | Device is SMS-only | Yes | The device supports SMS, so the event is triggered. |
| reachability-sms | Device is disconnected | No | The device cannot send SMS, so no event is send. |
| reachability-disconnected | Device can use data or SMS usage | No | The device is reachable, so no "disconnected" event is sent. |
| reachability-disconnected | Device is disconnected | Yes | The device is disconnected, so the event is triggered. |
This endpoint describes the event notification received on subscription listener side when the event occurred.
As for subscription, detailed description of the event notification is provided in the CAMARA API design guideline document.
_**WARNING**: This callback endpoint must be exposed on the consumer side as `POST /{$request.body#/sink}`.
Developers may provide a callback URL on which notifications regarding reachability-status can be received from the service provider.
If an event occurs the application will send events to the provided webhook - `sink`._
The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
This API requires the API consumer to identify a device as the subject of the API as follows:
- When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
- When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
- If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
- If the subject can be identified from the access token and the optional `device` object is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.
In multi-SIM scenarios where more than one mobile device is associated with a phone number (e.g. a smartphone with an associated smartwatch), it might not be possible to uniquely identify from that phone number the device for which reachability status notifications should be provided. If the phone number is used as the device identifier when creating a subscription for a multi-SIM scenario, the API may:
- respond with an error, or
- provide reachability status update notifications for the multi-SIM group as a whole, or
- provide reachability status update notifications only for a single device in the multi-SIM group, which may not be the intended device.
Possible solutions in such a scenario include:
- Using the authorisation code flow to obtain an access token, which will automatically identify the intended device
- Identifying the intended device from a unique identifier for that device, such as its source IP address and port
- Check with the SIM provider whether a unique "secondary" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available.
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.7.0
x-camara-commonalities: 0.5
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/DeviceStatus
servers:
- url: "{apiRoot}/device-reachability-status-subscriptions/v0.7"
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider, e.g. api.example.com or api.example.com/somepath
tags:
- name: Device reachability status subscription
description: Operation to manage event subscription on device reachability status event.
paths:
/subscriptions:
post:
tags:
- Device reachability status subscription
summary: "Create a device reachability status event subscription for a device"
description: Create a device reachability status event subscription for a device
operationId: createDeviceReachabilityStatusSubscription
parameters:
- $ref: '#/components/parameters/x-correlator'
security:
- openId:
- device-reachability-status-subscriptions:org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data:create
- device-reachability-status-subscriptions:org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms:create
- device-reachability-status-subscriptions:org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected:create
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionRequest"
examples:
Create Subscription:
$ref: "#/components/examples/CREATE_SUBSCRIPTION"
callbacks:
notifications:
"{$request.body#/sink}":
post:
summary: "notifications callback"
description: |
Important: this endpoint is to be implemented by the API consumer.
The Device status server will call this endpoint whenever any device reachability status related event occurs.
operationId: postNotification
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
required: true
content:
application/cloudevents+json:
schema:
$ref: "#/components/schemas/CloudEvent"
examples:
reachability-data:
$ref: "#/components/examples/REACHABILITY_DATA"
reachability-sms:
$ref: "#/components/examples/REACHABILITY_SMS"
reachability-disconnected:
$ref: "#/components/examples/REACHABILITY_DISCONNECTED"
subscription-ends:
$ref: "#/components/examples/SUBSCRIPTION_ENDS"
responses:
"204":
description: Successful notification
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"410":
$ref: "#/components/responses/Generic410"
"429":
$ref: "#/components/responses/Generic429"
security:
- {}
- notificationsBearerAuth: []
responses:
"201":
description: Created
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
examples:
subscription-active:
$ref: "#/components/examples/SUBSCRIPTION_ACTIVE"
"202":
description: Request accepted to be processed. It applies for async creation process.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionAsync"
"400":
$ref: "#/components/responses/CreateSubscriptionBadRequest400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/SubscriptionPermissionDenied403"
"409":
$ref: "#/components/responses/Generic409"
"422":
$ref: "#/components/responses/CreateSubscriptionUnprocessableEntity422"
"429":
$ref: "#/components/responses/Generic429"
get:
tags:
- Device reachability status subscription
summary: "Retrieve a list of device reachability status event subscription"
description: Retrieve a list of device reachability status event subscription(s)
operationId: retrieveDeviceReachabilityStatusSubscriptionList
parameters:
- $ref: "#/components/parameters/x-correlator"
security:
- openId:
- device-reachability-status-subscriptions:read
responses:
"200":
description: List of event subscription details
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: "#/components/schemas/Subscription"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
/subscriptions/{subscriptionId}:
get:
tags:
- Device reachability status subscription
summary: "Retrieve a device reachability status event subscription for a device"
operationId: retrieveDeviceReachabilityStatusSubscription
description: Retrieve a given subscription by ID
security:
- openId:
- device-reachability-status-subscriptions:read
parameters:
- $ref: "#/components/parameters/SubscriptionId"
- $ref: '#/components/parameters/x-correlator'
responses:
"200":
description: OK
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
examples:
subscription-active:
$ref: "#/components/examples/SUBSCRIPTION_ACTIVE"
subscription-activation-requested:
$ref: "#/components/examples/SUBSCRIPTION_ACTIVATION_REQUESTED"
subscription-deleted:
$ref: "#/components/examples/SUBSCRIPTION_DELETED"
"400":
$ref: "#/components/responses/SubscriptionIdRequired400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
delete:
tags:
- Device reachability status subscription
summary: "Delete a device reachability status event subscription for a device"
operationId: deleteDeviceReachabilityStatusSubscription
description: Delete a given subscription by ID
security:
- openId:
- device-reachability-status-subscriptions:delete
parameters:
- $ref: "#/components/parameters/SubscriptionId"
- $ref: '#/components/parameters/x-correlator'
responses:
"204":
description: event subscription deleted
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
"202":
description: Request accepted to be processed. It applies for async deletion process.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionAsync"
"400":
$ref: "#/components/responses/SubscriptionIdRequired400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
components:
securitySchemes:
openId:
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
notificationsBearerAuth:
type: http
scheme: bearer
bearerFormat: "{$request.body#/sinkCredential.credentialType}"
parameters:
SubscriptionId:
name: subscriptionId
in: path
description: Subscription identifier that was obtained from the create event subscription operation
required: true
schema:
$ref: "#/components/schemas/SubscriptionId"
x-correlator:
name: x-correlator
in: header
description: Correlation id for the different services
schema:
type: string
pattern: ^[a-zA-Z0-9-]{0,55}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
headers:
x-correlator:
description: Correlation id for the different services
schema:
type: string
pattern: ^[a-zA-Z0-9-]{0,55}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
schemas:
ErrorInfo:
type: object
required:
- status
- code
- message
properties:
status:
type: integer
description: HTTP response status code
code:
type: string
description: Code given to this error
message:
type: string
description: Detailed error description
SubscriptionRequest:
description: The request for creating a event-type event subscription
type: object
required:
- sink
- protocol
- config
- types
properties:
protocol:
$ref: "#/components/schemas/Protocol"
sink:
type: string
format: uri
description: The address to which events shall be delivered using the selected protocol.
example: "https://endpoint.example.com/sink"
sinkCredential:
$ref: "#/components/schemas/SinkCredential"
types:
description: |
Camara Event types eligible to be delivered by this subscription.
Note: For the current Commonalities API design guidelines, only one event type per subscription is allowed, yet in the following releases use of array of event types SHALL be specified without changing this definition.
type: array
minItems: 1
maxItems: 1
items:
$ref: "#/components/schemas/SubscriptionEventType"
config:
$ref: "#/components/schemas/Config"
discriminator:
propertyName: protocol
mapping:
HTTP: "#/components/schemas/HTTPSubscriptionRequest"
MQTT3: "#/components/schemas/MQTTSubscriptionRequest"
MQTT5: "#/components/schemas/MQTTSubscriptionRequest"
AMQP: "#/components/schemas/AMQPSubscriptionRequest"
NATS: "#/components/schemas/NATSSubscriptionRequest"
KAFKA: "#/components/schemas/ApacheKafkaSubscriptionRequest"
Protocol:
type: string
enum: ["HTTP", "MQTT3", "MQTT5", "AMQP", "NATS", "KAFKA"]
description: Identifier of a delivery protocol. Only HTTP is allowed for now
example: "HTTP"
Config:
description: |
Implementation-specific configuration parameters needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`
Specific event type attributes must be defined in `subscriptionDetail`
Note: if a request is performed for several event type, all subscribed event will use same `config` parameters.
type: object
required:
- subscriptionDetail
properties:
subscriptionDetail:
$ref: "#/components/schemas/CreateSubscriptionDetail"
subscriptionExpireTime:
type: string
format: date-time
example: 2023-01-17T13:18:23.682Z
description: The subscription expiration time (in date-time format) requested by the API consumer. Up to API project decision to keep it.
subscriptionMaxEvents:
type: integer
description: Identifies the maximum number of event reports to be generated (>=1) requested by the API consumer - Once this number is reached, the subscription ends. Up to API project decision to keep it.
minimum: 1
example: 5
initialEvent:
type: boolean
description: |
Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request.Up to API project decision to keep it.
Example: Consumer subscribes to reachability SMS. If consumer sets initialEvent to true and device is already reachable by SMS, an event is triggered.
SinkCredential:
description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
type: object
properties:
credentialType:
type: string
enum:
- PLAIN
- ACCESSTOKEN
- REFRESHTOKEN
description: |
The type of the credential.
Note: Type of the credential - MUST be set to ACCESSTOKEN for now
discriminator:
propertyName: credentialType
mapping:
PLAIN: "#/components/schemas/PlainCredential"
ACCESSTOKEN: "#/components/schemas/AccessTokenCredential"
REFRESHTOKEN: "#/components/schemas/RefreshTokenCredential"
required:
- credentialType
PlainCredential:
type: object
description: A plain credential as a combination of an identifier and a secret.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
required:
- identifier
- secret
properties:
identifier:
description: The identifier might be an account or username.
type: string
secret:
description: The secret might be a password or passphrase.
type: string
AccessTokenCredential:
type: object
description: An access token credential.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accessTokenExpiresUtc:
type: string
format: date-time
description: |
REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
example: "2023-07-03T12:27:08.312Z"
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
enum:
- bearer
required:
- accessToken
- accessTokenExpiresUtc
- accessTokenType
RefreshTokenCredential:
type: object
description: An access token credential with a refresh token.
allOf:
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:
description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
type: string
accessTokenExpiresUtc:
type: string
format: date-time
description: |
REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
example: "2023-07-03T12:27:08.312Z"
accessTokenType:
description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
type: string
enum:
- bearer
refreshToken:
description: REQUIRED. An refresh token credential used to acquire access tokens.
type: string
refreshTokenEndpoint:
type: string
format: uri
description: REQUIRED. A URL at which the refresh token can be traded for an access token.
required:
- accessToken
- accessTokenExpiresUtc
- accessTokenType
- refreshToken
- refreshTokenEndpoint
CreateSubscriptionDetail:
description: The detail of the requested event subscription.
type: object
properties:
device:
$ref: "#/components/schemas/Device"
EventTypeNotification:
type: string
description: |
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
reachability-sms - Event triggered when the device is connected to the network only for SMS usage
reachability-disconnected - Event triggered when the device is not connected.
subscription-ends - Event triggered when the subscription is terminated
enum:
- org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data
- org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms
- org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected
- org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends
SubscriptionEventType:
type: string
description: |
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability).
reachability-sms - Event triggered when the device is connected to the network only for SMS usage
reachability-disconnected - Event triggered when the device is not connected.
enum:
- org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data
- org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms
- org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected
Subscription:
description: Represents a event-type subscription.
type: object
required:
- sink
- protocol
- config
- types
- id
properties:
protocol:
$ref: "#/components/schemas/Protocol"
sink:
type: string
format: url
description: The address to which events shall be delivered using the selected protocol.
example: "https://endpoint.example.com/sink"
types:
description: |
Camara Event types eligible to be delivered by this subscription.
Note: For the current Commonalities API design guidelines, only one event type per subscription is allowed
type: array
minItems: 1
maxItems: 1
items:
$ref: "#/components/schemas/SubscriptionEventType"
config:
$ref: '#/components/schemas/Config'
id:
$ref: '#/components/schemas/SubscriptionId'
startsAt:
type: string
format: date-time
description: |
Date when the event subscription will begin/began
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
example: "2023-07-03T12:27:08.312Z"
expiresAt:
type: string
format: date-time
description: |
Date when the event subscription will expire. Only provided when `subscriptionExpireTime` is indicated by API client or Telco Operator has specific policy about that.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
example: "2023-07-03T12:27:08.312Z"
status:
type: string
description: |-
Current status of the subscription - Management of Subscription State engine is not mandatory for now. Note not all statuses may be considered to be implemented. Details:
- `ACTIVATION_REQUESTED`: Subscription creation (POST) is triggered but subscription creation process is not finished yet.
- `ACTIVE`: Subscription creation process is completed. Subscription is fully operative.
- `INACTIVE`: Subscription is temporarily inactive, but its workflow logic is not deleted.
- `EXPIRED`: Subscription is ended (no longer active). This status applies when subscription is ended due to `SUBSCRIPTION_EXPIRED` or `ACCESS_TOKEN_EXPIRED` event.
- `DELETED`: Subscription is ended as deleted (no longer active). This status applies when subscription information is kept (i.e. subscription workflow is no longer active but its meta-information is kept).
enum:
- ACTIVATION_REQUESTED
- ACTIVE
- EXPIRED
- INACTIVE
- DELETED
discriminator:
propertyName: protocol
mapping:
HTTP: "#/components/schemas/HTTPSubscriptionResponse"
MQTT3: "#/components/schemas/MQTTSubscriptionResponse"
MQTT5: "#/components/schemas/MQTTSubscriptionResponse"
AMQP: "#/components/schemas/AMQPSubscriptionResponse"
NATS: "#/components/schemas/NATSSubscriptionResponse"
KAFKA: "#/components/schemas/ApacheKafkaSubscriptionResponse"
example:
id: 550e8400-e29b-41d4-a716-446655440000
sink: https://endpoint.example.com/sink
protocol: HTTP
types:
- "org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data"
config:
subscriptionDetail:
device:
phoneNumber: "+123456789"
subscriptionExpireTime: "2024-07-17T13:18:23.682Z"
subscriptionMaxEvents: 5
initialEvent: true
startsAt: "2024-07-03T21:12:02.871Z"
expiresAt: "2024-07-03T21:12:02.871Z"
status: ACTIVE
Device:
description: |
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 the below specified device identifiers:
* `ipv4Address`
* `ipv6Address`
* `phoneNumber`
* `networkAccessIdentifier`
NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.
type: object
properties:
phoneNumber:
$ref: "#/components/schemas/PhoneNumber"
networkAccessIdentifier:
$ref: "#/components/schemas/NetworkAccessIdentifier"
ipv4Address:
$ref: "#/components/schemas/DeviceIpv4Addr"
ipv6Address:
$ref: "#/components/schemas/DeviceIpv6Address"
minProperties: 1
PhoneNumber:
description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
type: string
pattern: '^\+[1-9][0-9]{4,14}$'
example: "+123456789"
NetworkAccessIdentifier:
description: A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator.
type: string
example: "123456789@domain.com"
DeviceIpv4Addr:
type: object
description: |
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 (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers).
If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress.
If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object)
In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone.
properties:
publicAddress:
$ref: "#/components/schemas/SingleIpv4Addr"
privateAddress:
$ref: "#/components/schemas/SingleIpv4Addr"
publicPort:
$ref: "#/components/schemas/Port"
anyOf:
- required: [publicAddress, privateAddress]
- required: [publicAddress, publicPort]
example:
publicAddress: "84.125.93.10"
publicPort: 59765
SingleIpv4Addr:
description: A single IPv4 address with no subnet mask
type: string
format: ipv4
example: "84.125.93.10"
Port:
description: TCP or UDP port number
type: integer
minimum: 0
maximum: 65535
DeviceIpv6Address:
description: |
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 the /64 prefix).
type: string
format: ipv6
example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
SubscriptionAsync:
description: Response for a device reachability status operation managed asynchronously (Creation or Deletion)
type: object
properties:
id:
$ref: "#/components/schemas/SubscriptionId"
SubscriptionId:
type: string
description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as `subscriptionId` as per [Commonalities Event Notification Model](https://github.com/camaraproject/Commonalities/blob/r2.3/documentation/API-design-guidelines.md#122-event-notification).
example: qs15-h556-rt89-1298
CloudEvent:
description: The notification callback
required:
- id
- source
- specversion
- type
- time
properties:
id:
type: string
description: identifier of this event, that must be unique in the source context.
source:
$ref: "#/components/schemas/Source"
type:
$ref: "#/components/schemas/EventTypeNotification"
specversion:
type: string
description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version)
enum:
- "1.0"
datacontenttype:
type: string
description: 'media-type that describes the event payload encoding, must be "application/json" for CAMARA APIs'
enum:
- application/json
data:
type: object
description: Event details payload described in each CAMARA API and referenced by its type
time:
$ref: "#/components/schemas/DateTime"
discriminator:
propertyName: "type"
mapping:
org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data: "#/components/schemas/EventReachabilityData"
org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms: "#/components/schemas/EventReachabilitySms"
org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected: "#/components/schemas/EventReachabilityDisconnected"
org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends: "#/components/schemas/EventSubscriptionEnds"
Source:
type: string
format: uri-reference
minLength: 1
description: |
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-wg-serverless@lists.cncf.io
- Universally-unique URN with a UUID:
* urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66
- Application-specific identifier:
* /cloudevents/spec/pull/123
* 1-555-123-4567
example: "https://notificationSendServer12.supertelco.com"
DateTime:
type: string
format: date-time
description: |
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 current time) by the CloudEvents producer,
however all producers for the same source MUST be consistent in this respect. In other words,
either they all use the actual time of the occurrence or they all use the same algorithm to determine the value used.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
example: "2018-04-05T17:31:00Z"
EventReachabilityData:
description: event structure for reachability data usage
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/ReachabilityDataSmsDisconnected"
EventReachabilitySms:
description: event structure for reachability SMS usage
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/ReachabilityDataSmsDisconnected"
EventReachabilityDisconnected:
description: event structure for disconnection
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/ReachabilityDataSmsDisconnected"
ReachabilityDataSmsDisconnected:
required:
- subscriptionId
properties:
device:
$ref: "#/components/schemas/Device"
subscriptionId:
$ref: "#/components/schemas/SubscriptionId"
EventSubscriptionEnds:
description: event structure for event subscription ends
allOf:
- $ref: "#/components/schemas/CloudEvent"
- type: object
properties:
data:
$ref: "#/components/schemas/SubscriptionEnds"
SubscriptionEnds:
description: Event detail structure for org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends event
type: object
required:
- terminationReason
- subscriptionId
properties:
device:
$ref: "#/components/schemas/Device"
terminationReason:
$ref: "#/components/schemas/TerminationReason"
subscriptionId:
$ref: "#/components/schemas/SubscriptionId"
terminationDescription:
type: string
TerminationReason:
type: string
description: |
- NETWORK_TERMINATED - API server stopped sending notification
- SUBSCRIPTION_EXPIRED - Subscription expire time (optionally set by the requester) has been reached
- MAX_EVENTS_REACHED - Maximum number of events (optionally set by the requester) has been reached
- ACCESS_TOKEN_EXPIRED - Access Token sinkCredential (optionally set by the requester) expiration time has been reached
- SUBSCRIPTION_DELETED - Subscription was deleted by the requester
enum:
- MAX_EVENTS_REACHED
- NETWORK_TERMINATED
- SUBSCRIPTION_EXPIRED
- ACCESS_TOKEN_EXPIRED
- SUBSCRIPTION_DELETED
HTTPSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/HTTPSettings"
HTTPSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/HTTPSettings"
HTTPSettings:
type: object
properties:
headers:
type: object
description: |-
A set of key/value pairs that is copied into the HTTP request as custom headers.
NOTE: Use/Applicability of this concept has not been discussed in Commonalities under the scope of Meta Release v0.4. When required by an API project as an option to meet a UC/Requirement, please generate an issue for Commonalities discussion about it.
additionalProperties:
type: string
method:
type: string
description: The HTTP method to use for sending the message.
enum:
- POST
MQTTSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/MQTTSettings"
MQTTSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/MQTTSettings"
MQTTSettings:
type: object
properties:
topicName:
type: string
qos:
type: integer
format: int32
retain:
type: boolean
expiry:
type: integer
format: int32
userProperties:
type: object
required:
- topicName
AMQPSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/AMQPSettings"
AMQPSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/AMQPSettings"
AMQPSettings:
type: object
properties:
address:
type: string
linkName:
type: string
senderSettlementMode:
type: string
enum: ["settled", "unsettled"]
linkProperties:
type: object
additionalProperties:
type: string
ApacheKafkaSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/ApacheKafkaSettings"
ApacheKafkaSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/ApacheKafkaSettings"
ApacheKafkaSettings:
type: object
properties:
topicName:
type: string
partitionKeyExtractor:
type: string
clientId:
type: string
ackMode:
type: integer
required:
- topicName
NATSSubscriptionRequest:
allOf:
- $ref: "#/components/schemas/SubscriptionRequest"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/NATSSettings"
NATSSubscriptionResponse:
allOf:
- $ref: "#/components/schemas/Subscription"
- type: object
properties:
protocolSettings:
$ref: "#/components/schemas/NATSSettings"
NATSSettings:
type: object
properties:
subject:
type: string
required:
- subject
responses:
CreateSubscriptionBadRequest400:
description: Problem with the client request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
- OUT_OF_RANGE
- INVALID_PROTOCOL
- INVALID_CREDENTIAL
- INVALID_TOKEN
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param.
GENERIC_400_OUT_OF_RANGE:
description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
value:
status: 400
code: OUT_OF_RANGE
message: Client specified an invalid range.
GENERIC_400_INVALID_PROTOCOL:
description: Invalid protocol for events subscription management
value:
status: 400
code: INVALID_PROTOCOL
message: Only HTTP is supported
GENERIC_400_INVALID_CREDENTIAL:
description: Invalid sink credential type
value:
status: 400
code: INVALID_CREDENTIAL
message: Only Access token is supported
GENERIC_400_INVALID_TOKEN:
description: Invalid token type for sink credential of type ACCESSTOKEN
value:
status: 400
code: INVALID_TOKEN
message: Only bearer token is supported
Generic400:
description: Problem with the client request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param.
SubscriptionIdRequired400:
description: Problem with the client request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
value:
status: 400
code: INVALID_ARGUMENT
message: Client specified an invalid argument, request body or query param.
GENERIC_400_SUBSCRIPTION_ID_REQUIRED:
description: subscription id is required
value:
status: 400
code: INVALID_ARGUMENT
message: "Expected property is missing: subscriptionId"
Generic401:
description: Authentication problem with the client request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 401
code:
enum:
- UNAUTHENTICATED
- AUTHENTICATION_REQUIRED
examples:
GENERIC_401_UNAUTHENTICATED:
description: Request cannot be authenticated
value:
status: 401
code: UNAUTHENTICATED
message: Request not authenticated due to missing, invalid, or expired credentials.
GENERIC_401_AUTHENTICATION_REQUIRED:
description: New authentication is needed, authentication is no longer valid
value:
status: 401
code: AUTHENTICATION_REQUIRED
message: New authentication is required.
Generic403:
description: Client does not have sufficient permission
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 403
code:
enum:
- PERMISSION_DENIED
examples:
GENERIC_403_PERMISSION_DENIED:
description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
value:
status: 403
code: PERMISSION_DENIED
message: Client does not have sufficient permissions to perform this action.
SubscriptionPermissionDenied403:
description: Client does not have sufficient permission
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 403
code:
enum:
- PERMISSION_DENIED
- SUBSCRIPTION_MISMATCH
examples:
GENERIC_403_PERMISSION_DENIED:
description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
value:
status: 403
code: PERMISSION_DENIED
message: Client does not have sufficient permissions to perform this action.
GENERIC_403_SUBSCRIPTION_MISMATCH:
description: Inconsistent access token for requested subscription
value:
status: 403
code: "SUBSCRIPTION_MISMATCH"
message: "Inconsistent access token for requested events subscription"
Generic404:
description: Resource Not Found
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 404
code:
enum:
- NOT_FOUND
examples:
GENERIC_404_NOT_FOUND:
description: Resource is not found
value:
status: 404
code: NOT_FOUND
message: The specified resource is not found.
Generic409:
description: Conflict
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 409
code:
enum:
- ABORTED
- ALREADY_EXISTS
examples:
GENERIC_409_ABORTED:
description: Concurreny of processes of the same nature/scope
value:
status: 409
code: ABORTED
message: Concurrency conflict.
GENERIC_409_ALREADY_EXISTS:
description: Trying to create an existing resource
value:
status: 409
code: ALREADY_EXISTS
message: The resource that a client tried to create already exists.
Generic410:
description: Gone
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 410
code:
enum:
- GONE
examples:
GENERIC_410_GONE:
description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available
value:
status: 410
code: GONE
message: Access to the target resource is no longer available.
CreateSubscriptionUnprocessableEntity422:
description: Unprocessable Entity
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 422
code:
enum:
- IDENTIFIER_MISMATCH
- SERVICE_NOT_APPLICABLE
- MISSING_IDENTIFIER
- UNSUPPORTED_IDENTIFIER
- UNNECESSARY_IDENTIFIER
- MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED
examples:
GENERIC_422_IDENTIFIER_MISMATCH:
description: Inconsistency between identifiers not pointing to the same device
value:
status: 422
code: IDENTIFIER_MISMATCH
message: Provided identifiers are not consistent.
GENERIC_422_SERVICE_NOT_APPLICABLE:
description: Service not applicable for the provided identifier
value:
status: 422
code: SERVICE_NOT_APPLICABLE
message: The service is not available for the provided identifier.
GENERIC_422_MISSING_IDENTIFIER:
description: An identifier is not included in the request and the device or phone number identification cannot be derived from the 3-legged access token
value:
status: 422
code: MISSING_IDENTIFIER
message: The device cannot be identified.
GENERIC_422_UNSUPPORTED_IDENTIFIER:
description: None of the provided identifiers is supported by the implementation
value:
status: 422
code: UNSUPPORTED_IDENTIFIER
message: The identifier provided is not supported.
GENERIC_422_UNNECESSARY_IDENTIFIER:
description: An explicit identifier is provided when a device or phone number has already been identified from the access token
value:
status: 422
code: UNNECESSARY_IDENTIFIER
message: The device is already identified by the access token.
GENERIC_422_MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED:
description: Multi event types subscription is not supported
value:
status: 422
code: MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED
message: Multi event types subscription not managed
Generic429:
description: Too Many Requests
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 429
code:
enum:
- QUOTA_EXCEEDED
- TOO_MANY_REQUESTS
examples:
GENERIC_429_QUOTA_EXCEEDED:
description: Request is rejected due to exceeding a business quota limit
value:
status: 429
code: QUOTA_EXCEEDED
message: Out of resource quota.
GENERIC_429_TOO_MANY_REQUESTS:
description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached
value:
status: 429
code: TOO_MANY_REQUESTS
message: Rate limit reached.
examples:
REACHABILITY_DATA:
value:
id: "123656"
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data
specversion: "1.0"
datacontenttype: application/json
data:
device:
phoneNumber: "+123456789"
subscriptionId: qs15-h556-rt89-1298
time: "2023-01-19T13:18:23.682Z"
REACHABILITY_SMS:
value:
id: "123656"
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms
specversion: "1.0"
datacontenttype: application/json
data:
device:
phoneNumber: "+123456789"
subscriptionId: qs15-h556-rt89-1298
time: "2023-01-19T13:18:23.682Z"
REACHABILITY_DISCONNECTED:
value:
id: "123656"
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected
specversion: "1.0"
datacontenttype: application/json
data:
device:
phoneNumber: "+123456789"
subscriptionId: qs15-h556-rt89-1298
time: "2023-01-19T13:18:23.682Z"
SUBSCRIPTION_ENDS:
value:
id: "123658"
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends
specversion: "1.0"
datacontenttype: application/json
data:
device:
phoneNumber: "+123456789"
terminationReason: SUBSCRIPTION_EXPIRED
subscriptionId: qs15-h556-rt89-1298
terminationDescription: Subscription expiry time has been reached
time: "2024-03-22T05:40:23.682Z"
SUBSCRIPTION_ACTIVE:
value:
id: 550e8400-e29b-41d4-a716-446655440000
sink: https://endpoint.example.com/sink
protocol: HTTP
types:
- "org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data"
config:
subscriptionDetail:
device:
phoneNumber: "+123456789"
subscriptionExpireTime: "2024-07-17T13:18:23.682Z"
subscriptionMaxEvents: 5
initialEvent: true
startsAt: "2024-07-03T21:12:02.871Z"
expiresAt: "2024-07-03T21:12:02.871Z"
status: ACTIVE
SUBSCRIPTION_ACTIVATION_REQUESTED:
value:
id: 550e8400-e29b-41d4-a716-446655440000
sink: https://endpoint.example.com/sink
protocol: HTTP
types:
- "org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data"
config:
subscriptionDetail:
device:
phoneNumber: "+123456789"
subscriptionExpireTime: "2024-07-17T13:18:23.682Z"
subscriptionMaxEvents: 5
initialEvent: true
startsAt: "2024-07-03T21:12:02.871Z"
expiresAt: "2024-07-03T21:12:02.871Z"
status: ACTIVATION_REQUESTED
SUBSCRIPTION_DELETED:
value:
id: 550e8400-e29b-41d4-a716-446655440000
sink: https://endpoint.example.com/sink
protocol: HTTP
types:
- "org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data"
config:
subscriptionDetail:
device:
phoneNumber: "+123456789"
subscriptionExpireTime: "2024-07-17T13:18:23.682Z"
subscriptionMaxEvents: 5
initialEvent: true
startsAt: "2024-07-03T21:12:02.871Z"
expiresAt: "2024-07-03T21:12:02.871Z"
status: DELETED
CREATE_SUBSCRIPTION:
value:
sink: "https://endpoint.example.com/sink"
sinkCredential: {
"credentialType": "ACCESSTOKEN",
"accessToken": "JhbGciOiJSUzI1NiIsImtpZCI6Imk2bEdrM0ZaenhSY1ViMkMzbkVRN3N5SEpsW",
"accessTokenExpiresUtc": "2024-02-17T16:23:45Z",
"accessTokenType": "bearer"
}
protocol: HTTP
types: [
"org.camaraproject.device-reachability-status-subscriptions.v0.reachability-data"
]
config: {
"subscriptionDetail": {
"device": {
"phoneNumber": "+123456789",
}
},
"subscriptionExpireTime": "2023-01-17T13:18:23.682Z",
"subscriptionMaxEvents": 5,
"initialEvent": true
}
