Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/open-gateway-device-reachability-status-subscription-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no email required.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Device Reachability Status Subscriptions Device reachability status subscription API
description: "This API provides the API consumer with the ability to subscribe to Reachability status events.\n\n# Introduction\n\n## Reachability Status\nAPI consumer is able to be notified whether the reachability status of a certain user device has changed to either data- or sms-usage.\nThis 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.\n\n# Relevant terms and definitions\n\n* **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.\n\n At least one identifier for the device out of four options must be provided: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. Where more than one device identifier is provided, only one identifier will be selected by the implementation and this choice indicated to the API consumer in the session creation response.\n\n Note: Network Access Identifier is defined for future use and will not be supported with this version of the API.\n\n# API Functionality\n\nThe API exposes following capability:\n\n## Device reachability status subscription\n\nThese endpoints allow to manage event subscription on reachability device status event.\nThe CAMARA subscription model is detailed in the CAMARA API design guideline document and follows CloudEvents specification.\n\nWhen subscribing, it is mandatory to provide the event `types` you are subscribing to, as multiple subscription-types are managed by this API.\n\nFollowing event ``types`` are managed for this API:\n - ``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).\n\n - ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-sms``: Event triggered when the device is connected to the network only for SMS usage\n\n - ``org.camaraproject.device-reachability-status-subscriptions.v0.reachability-disconnected``: Event triggered when the device is not connected.\n\nNote: Additionally, the following events could be sent, which do not require a dedicated subscription:\n - `org.camaraproject.device-reachability-status-subscriptions.v0.subscription-started` is sent when the subscription starts.\n - `org.camaraproject.device-reachability-status-subscriptions.v0.subscription-updated` is sent when the subscription is updated.\n - `org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ended` is sent when the subscription ends.\n\nIt is used in following cases:\n - the subscription expire time (optionally set by the requester) has been reached\n - the maximum number of subscription events (optionally set by the requester) has been reached\n - the subscription was deleted by the requester\n - the Access Token `sinkCredential` (optionally set by the requester) expiration time has been reached\n - the API server has to stop sending notification prematurely\n\n**Note on combined usage of ``initialEvent`` and ``subscriptionMaxEvents``**:\n\nIf an event is triggered following ``initialEvent`` set to true,\nthis event will be counted towards ``subscriptionMaxEvents`` (if provided).\n\n**Clarification on ``initialEvent`` & ``event-type`` behaviour:**\n\nFollowing table illustrate behaviour regarding event triggering depending on **initial** reachability state of the device:\n\n| subscribed event-type | device reachability status at subscription time | event sent if ``initialEvent`` set to true | Explanation |\n| ----------------------| ------------- | --------------- | ---------------|\n| reachability-data | Device can use data | Yes | The device is reachable for data, so the event is triggered. |\n| reachability-data | Device is disconnected or SMS-only | No | The device cannot use data, so no event is sent. |\n| reachability-sms | Device can use data | No | The device can use data, but for thids event is only for SMS. |\n| reachability-sms | Device is SMS-only | Yes | The device supports SMS, so the event is triggered. |\n| reachability-sms | Device is disconnected | No | The device cannot send SMS, so no event is send. |\n| reachability-disconnected | Device can use data or SMS usage | No | The device is reachable, so no \"disconnected\" event is sent. |\n| reachability-disconnected | Device is disconnected | Yes | The device is disconnected, so the event is triggered. |\n\n### Notifications callback\n\nThis endpoint describes the event notification received on subscription listener side when the event occurred.\nAs for subscription, detailed description of the event notification is provided in the CAMARA API design guideline document.\n\n_**WARNING**: This callback endpoint must be exposed on the consumer side as `POST /{$request.body#/sink}`.\n Developers may provide a callback URL on which notifications regarding reachability-status can be received from the service provider.\n If an event occurs the application will send events to the provided webhook - `sink`._\n\n# Further info and support\n\n## Authorization and authentication\n\nThe \"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.\n\nThe 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.\n\nIn 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.\n\n## Identifying the device from the access token\n\nThis API requires the API consumer to identify a device as the subject of the API as follows:\n- 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.\n\n- 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.\n\nThis 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.\n\n### Error handling:\n- 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.\n\n- 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.\n\n## Multi-SIM scenario handling\n\nIn 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:\n- respond with an error, or\n- provide reachability status update notifications for the multi-SIM group as a whole, or\n- provide reachability status update notifications only for a single device in the multi-SIM group, which may not be the intended device.\n\nPossible solutions in such a scenario include:\n- Using the authorisation code flow to obtain an access token, which will automatically identify the intended device\n- Identifying the intended device from a unique identifier for that device, such as its source IP address and port\n- 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.\n\n## Additional CAMARA error responses\n\nThe list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.\n\nPlease refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.\n\nAs a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.\n"
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.8.0
x-camara-commonalities: 0.6
servers:
- url: '{apiRoot}/device-reachability-status-subscriptions/v0.8'
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-started:
$ref: '#/components/examples/SUBSCRIPTION_STARTED'
subscription-updated:
$ref: '#/components/examples/SUBSCRIPTION_UPDATED'
subscription-ended:
$ref: '#/components/examples/SUBSCRIPTION_ENDED'
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:
Active Subscription:
$ref: '#/components/examples/ACTIVE_SUBSCRIPTION'
Active Subscription With Device Disambiguation:
$ref: '#/components/examples/ACTIVE_SUBSCRIPTION_WITH_DEVICE_DISAMBIGUATION'
'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'
examples:
List of Subscriptions:
$ref: '#/components/examples/SUBSCRIPTION_LIST'
Empty List of Subscriptions:
$ref: '#/components/examples/EMPTY_SUBSCRIPTION_LIST'
'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:
Active Subscription:
$ref: '#/components/examples/ACTIVE_SUBSCRIPTION'
Active Subscription With Device Disambiguation:
$ref: '#/components/examples/ACTIVE_SUBSCRIPTION_WITH_DEVICE_DISAMBIGUATION'
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:
schemas:
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-started - Event triggered when the subscription starts.
subscription-updated - Event triggered when the subscription is updated.
subscription-ended - Event triggered when the subscription ends.
'
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-started
- org.camaraproject.device-reachability-status-subscriptions.v0.subscription-updated
- org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ended
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-17 13:18:23.682000+00:00
description: The subscription expiration time (in date-time format) requested by the API consumer.
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.
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.
Example: Consumer subscribes to reachability SMS. If consumer sets initialEvent to true and device is already reachable by SMS, an event is triggered.
'
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-started: '#/components/schemas/EventSubscriptionStarted'
org.camaraproject.device-reachability-status-subscriptions.v0.subscription-updated: '#/components/schemas/EventSubscriptionUpdated'
org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ended: '#/components/schemas/EventSubscriptionEnded'
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: b4333c46-49c0-4f62-80d7-f0ef930f1c46
SubscriptionAsync:
description: Response for a device reachability status operation managed asynchronously (Creation or Deletion)
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/SubscriptionId'
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'
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: uri
pattern: ^https:\/\/.+$
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:\n - `ACTIVATION_REQUESTED`: Subscription creation (POST) is triggered but subscription creation process is not finished yet.\n - `ACTIVE`: Subscription creation process is completed. Subscription is fully operative.\n - `INACTIVE`: Subscription is temporarily inactive, but its workflow logic is not deleted.\n - `EXPIRED`: Subscription is ended (no longer active). This status applies when subscription is ended due to `SUBSCRIPTION_EXPIRED` or `ACCESS_TOKEN_EXPIRED` event.\n - `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
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.
example: qs15-h556-rt89-1298
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
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
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
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:
-
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-gateway/refs/heads/main/openapi/open-gateway-device-reachability-status-subscription-api-openapi.yml