openapi: 3.0.3 info: title: Call Forwarding Signal Age Verification Geofencing subscriptions API description: '# Overview The Call Forwarding Signal API provides the API Consumer with information about the status of the Call Forwarding Service on a specific phone number. The main scope of the Call Forwarding Signal API is "anti Fraud" to avoid fraudsters to use the Call Forwarding Service to carry on a scam. Other use cases are anyway supported by the Call Forwarding Signal API that also provides additional endpoints to detect the general Call Forwarding Service settings. # Introduction The Call Forwarding Service is provided by the Network to a phone number. This service redirects the incoming call to that phone number to an alternative destination such as another phone number or a voice mail system. There are two main types of call forwarding settings: unconditional and conditional. The Call Forwarding Signal API can be invoked to detect if the unconditional call forwarding service is active. The Call Forwarding Signal API can also be invoked to get the general status of the Call Forwarding Service (inactive, conditional, unconditional). If conditional call forwarding is active, the different type of settings are returned (''conditional_busy'', ''conditional_not_reachable'', ''conditional_no_answer''). **Example use cases:** [**Bank Frauds**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8694420) [**Alert Interception**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8701847) [**Call Forwarding Verification**](https://github.com/camaraproject/CallForwarding\Signal/discussions/3#discussioncomment-8915595) # Quick Start The Call Forwarding Signal API is a REST API based on the CreateCallForwardingSignal resource. This resource can be used, by the API Consumer, to specify the phone number on which the Call Forwarding Service status must be verified, in case of two-legged authentication. If three-legged authentication is used the phone number is instead detected, by the API Producer, from the access token. Before starting to use the Call Forwarding API, the developer needs to know about the below specified details: **phoneNumber** This is the end user phone number. The Call Forwarding Signal API verifies if a call forwarding service is active on this phone number. Note: this parameter must be must be provided/valued only in case of two-legged authentication. In case of three-legged authentication the phone number is retrieved by the access token. **CreateCallForwardingSignal** This is the resource the API Consumer uses to define the phone number to be verified about the status of the Network Call Forwarding service. **UnconditionalCallForwardingSignal** This is the resource the API Consumer gets back, containing the information about the Unconditional Call Forwarding Service status for the given phone number (PhoneNumber). **CallForwardingSignal** This is the resource the API Consumer gets back, containing the information about the general status of the Network Call Forwarding service for the specified phone number. The Call Forwarding Signal API provides two endpoints fulfilling the following intents: - **unconditional-call-forwardings**: Is the unconditional call fwd service active on a specific phone number? - **call-forwardings**: Which is the status of the call forwarding for a specific phone number? # API Documentation ## Details The Call Forwarding Signal API is invoked by an API Consumer after the Consent Management flow. The API Consumer can request the API Producer for the status of the Unconditional Call Forwarding service using the unconditional-call-forwardings POST method. A boolean, with the information about the activation status of the call forwarding service, will be provided back via the UnconditionalCallForwardingSignal resource. The API Consumer can also request the API Producer for the generic status of the Call Forwarding service using the call-forwardings POST method. An array of strings with the information of the type of active call forwarding services will be provided back via the CallForwardingSignal resource. # Authorization and authentication 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. # Identifying the phone number from the access token This API requires the API consumer to identify a phone number 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 `phoneNumber` object field, 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. ## Error handling: - If the subject cannot be identified from the access token and the optional `phoneNumber` object field 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 `phoneNumber` object field 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. # Additional CAMARA error responses The 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`. Please 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. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. # FAQ''s (FAQs will be added in a later version of the documentation) ' version: wip license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html x-camara-commonalities: 0.6 servers: - url: '{apiRoot}/call-forwarding-signal/vwip' 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: Geofencing subscriptions description: Operations to manage event subscriptions on geofencing events for leaving and entering an area. paths: /subscriptions: post: tags: - Geofencing subscriptions summary: Create a geofencing subscription for a device description: Create a subscription for a device to receive notifications when the device enters or exits a specified area. operationId: createGeofencingSubscription parameters: - $ref: '#/components/parameters/x-correlator' security: - openId: - geofencing-subscriptions:org.camaraproject.geofencing-subscriptions.v0.area-entered:create - geofencing-subscriptions:org.camaraproject.geofencing-subscriptions.v0.area-left:create requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRequest' examples: CIRCLE_AREA_ENTERED: $ref: '#/components/examples/REQUEST_CIRCLE_AREA_ENTERED' REQUEST_CIRCLE_AREA_ENTERED_MULTIPLE_IDENTIFIERS: $ref: '#/components/examples/REQUEST_CIRCLE_AREA_ENTERED_MULTIPLE_IDENTIFIERS' required: true callbacks: notifications: '{$request.body#/sink}': post: summary: notifications callback description: 'Important: This endpoint is to be implemented by the API consumer. The Geofencing server will call this endpoint whenever a Geofencing event occurs. The `operationId` value will have to be replaced accordingly with WG API specific semantics. ' operationId: postNotification parameters: - $ref: '#/components/parameters/x-correlator' requestBody: required: true content: application/cloudevents+json: schema: $ref: '#/components/schemas/CloudEvent' examples: CIRCLE_AREA_ENTERED: $ref: '#/components/examples/CIRCLE_AREA_ENTERED' CIRCLE_AREA_LEFT: $ref: '#/components/examples/CIRCLE_AREA_LEFT' SUBSCRIPTION_STARTED: $ref: '#/components/examples/SUBSCRIPTION_STARTED' SUBSCRIPTION_UPDATED: $ref: '#/components/examples/SUBSCRIPTION_UPDATED' SUBSCRIPTION_ENDED: $ref: '#/components/examples/SUBSCRIPTION_ENDED' SUBSCRIPTION_UNPROCESSABLE: $ref: '#/components/examples/SUBSCRIPTION_UNPROCESSABLE' 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 (Successful creation of subscription). headers: x-correlator: $ref: '#/components/headers/x-correlator' content: application/json: schema: $ref: '#/components/schemas/Subscription' '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/Generic403' '422': $ref: '#/components/responses/CreateSubscriptionUnprocessableEntity422' '429': $ref: '#/components/responses/Generic429' get: tags: - Geofencing subscriptions summary: Retrieve a list of geofencing event subscription description: Retrieve a list of geofencing event subscription(s). operationId: retrieveGeofencingSubscriptionList parameters: - $ref: '#/components/parameters/x-correlator' security: - openId: - geofencing-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: - Geofencing subscriptions summary: Operation to retrieve a subscription based on the provided ID description: Retrieve Geofencing subscription information for a given subscription ID. operationId: retrieveGeofencingSubscription security: - openId: - geofencing-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' '400': $ref: '#/components/responses/SubscriptionIdRequired' '401': $ref: '#/components/responses/Generic401' '403': $ref: '#/components/responses/Generic403' '404': $ref: '#/components/responses/Generic404' delete: tags: - Geofencing subscriptions summary: Delete a Geofencing event subscription operationId: deleteGeofencingSubscription description: Delete a given Geofencing subscription. security: - openId: - geofencing-subscriptions:delete parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/x-correlator' responses: '204': description: Geofencing 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/SubscriptionIdRequired' '401': $ref: '#/components/responses/Generic401' '403': $ref: '#/components/responses/Generic403' '404': $ref: '#/components/responses/Generic404' components: examples: SUBSCRIPTION_STARTED: description: The cloud event when a geofence subscription was started. value: id: '124003' source: https://dataUsageServer.supertelco.com type: org.camaraproject.geofencing-subscriptions.v0.subscription-started specversion: '1.0' datacontenttype: application/json data: initiationReason: SUBSCRIPTION_CREATED subscriptionId: dv10-h556-rt89-1403 device: phoneNumber: 123456789 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 time: '2024-03-05T15:00:23.682Z' CIRCLE_AREA_ENTERED: description: The cloud event when a geofence area was entered. value: id: '123655' source: https://notificationSendServer12.supertelco.com type: org.camaraproject.geofencing-subscriptions.v0.area-entered specversion: '1.0' datacontenttype: application/json time: 2023-03-22 05:40:23.682000+00:00 data: subscriptionId: 987654321 device: phoneNumber: 123456789 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 CIRCLE_AREA_LEFT: description: The cloud event when a geofence area was left. value: id: '123655' source: https://notificationSendServer12.supertelco.com type: org.camaraproject.geofencing-subscriptions.v0.area-left specversion: '1.0' datacontenttype: application/json time: 2023-03-22 05:40:23.682000+00:00 data: subscriptionId: 987654321 device: phoneNumber: 123456789 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 SUBSCRIPTION_UNPROCESSABLE: description: The cloud event when the subscription process was aborted. value: id: '123655' source: https://notificationSendServer12.supertelco.com type: org.camaraproject.geofencing-subscriptions.v0.subscription-ended specversion: '1.0' datacontenttype: application/json time: 2023-03-22 05:40:23.682000+00:00 data: device: phoneNumber: 123456789 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 terminationReason: SUBSCRIPTION_UNPROCESSABLE terminationDescription: The requested area cannot be covered by the network. REQUEST_CIRCLE_AREA_ENTERED: description: A sample geofence for entering for a circle area. value: protocol: HTTP sink: https://notificationSendServer12.supertelco.com types: - org.camaraproject.geofencing-subscriptions.v0.area-entered config: subscriptionDetail: device: phoneNumber: '+12345678912' area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 initialEvent: true subscriptionMaxEvents: 10 subscriptionExpireTime: '2024-03-22T05:40:58.469Z' REQUEST_CIRCLE_AREA_ENTERED_MULTIPLE_IDENTIFIERS: description: A sample geofence for entering for a circle area. value: protocol: HTTP sink: https://notificationSendServer12.supertelco.com types: - org.camaraproject.geofencing-subscriptions.v0.area-entered config: subscriptionDetail: device: phoneNumber: '+12345678912' ipv4Address: publicAddress: 123.234.1.2 publicPort: 1234 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 initialEvent: true subscriptionMaxEvents: 10 subscriptionExpireTime: '2024-03-22T05:40:58.469Z' SUBSCRIPTION_UPDATED: description: The cloud event when a geofence subscription was updated. value: id: '124003' source: https://dataUsageServer.supertelco.com type: org.camaraproject.geofencing-subscriptions.v0.subscription-updated specversion: '1.0' datacontenttype: application/json data: updateReason: SUBSCRIPTION_ACTIVE subscriptionId: dv10-h556-rt89-1403 device: phoneNumber: 123456789 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 time: '2024-03-05T15:00:23.682Z' SUBSCRIPTION_ENDED: description: The cloud event when a geofence subscription ended. value: id: '123655' source: https://notificationSendServer12.supertelco.com type: org.camaraproject.geofencing-subscriptions.v0.subscription-ended specversion: '1.0' datacontenttype: application/json time: 2023-03-22 05:40:23.682000+00:00 data: subscriptionId: 987654321 device: phoneNumber: 123456789 area: areaType: CIRCLE center: latitude: 50.735851 longitude: 7.10066 radius: 2000 terminationReason: SUBSCRIPTION_EXPIRED schemas: NotificationEventType: type: string description: 'area-entered - Event triggered when the device enters the given area area-left - Event triggered when the device leaves the given area 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.geofencing-subscriptions.v0.area-entered - org.camaraproject.geofencing-subscriptions.v0.area-left - org.camaraproject.geofencing-subscriptions.v0.subscription-started - org.camaraproject.geofencing-subscriptions.v0.subscription-updated - org.camaraproject.geofencing-subscriptions.v0.subscription-ended 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 SubscriptionAsync: description: Response for an event-type subscription request managed asynchronously (Creation or Deletion). type: object required: - id properties: id: $ref: '#/components/schemas/SubscriptionId' ConfigResponse: allOf: - $ref: '#/components/schemas/Config' - description: 'Implementation-specific configuration parameters are needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`. Specific event type attributes granted by the implementation are included in `subscriptionDetail`. Note: If a request is performed for several event types, all subscribed events will use the same `config` parameters. ' type: object required: - subscriptionDetail properties: subscriptionDetail: $ref: '#/components/schemas/SubscriptionDetailResponse' CloudEvent: description: The notification callback. required: - id - source - specversion - type - time - data 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/NotificationEventType' 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.geofencing-subscriptions.v0.area-left: '#/components/schemas/EventAreaLeft' org.camaraproject.geofencing-subscriptions.v0.area-entered: '#/components/schemas/EventAreaEntered' org.camaraproject.geofencing-subscriptions.v0.subscription-started: '#/components/schemas/EventSubscriptionStarted' org.camaraproject.geofencing-subscriptions.v0.subscription-updated: '#/components/schemas/EventSubscriptionUpdated' org.camaraproject.geofencing-subscriptions.v0.subscription-ended: '#/components/schemas/EventSubscriptionEnded' SingleIpv4Addr: description: A single IPv4 address with no subnet mask. type: string format: ipv4 example: 84.125.93.10 SubscriptionRequest: description: The request for creating an event-type event subscription. type: object required: - sink - protocol - config - types 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 sinkCredential: $ref: '#/components/schemas/SinkCredential' types: description: 'Camara Event types which are eligible to be delivered by this subscription. Note: As of now we enforce to have only event type per subscription. ' type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/SubscriptionEventType' config: $ref: '#/components/schemas/ConfigRequest' 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' 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 DeviceResponse: description: '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 includes the `device` parameter in their request (i.e. they are using a two-legged access token), and is relevant when more than one device identifier is specified, as only one of those device identifiers is allowed in the response. If the API consumer provides more than one device identifier in their request, the API provider must return a single identifier which is the one they are using to fulfil the request, even if the identifiers do not match the same device. API provider does not perform any logic to validate/correlate that the indicated device identifiers match the same device. No error should be returned if the identifiers are otherwise valid to prevent API consumers correlating different identifiers with a given end user. ' allOf: - $ref: '#/components/schemas/Device' - maxProperties: 1 AreaType: type: string description: 'Type of this area. CIRCLE - The area is defined as a circle. ' enum: - CIRCLE XCorrelator: type: string pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ example: b4333c46-49c0-4f62-80d7-f0ef930f1c46 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' 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: 'area-entered - Event triggered when the device enters the given area area-left - Event triggered when the device leaves the given area ' enum: - org.camaraproject.geofencing-subscriptions.v0.area-entered - org.camaraproject.geofencing-subscriptions.v0.area-left Area: type: object description: The geofencing area where the monitor is active. This area is specified by API consumers in the subscription request. The same area definition is included in event notifications without any modifications. properties: areaType: $ref: '#/components/schemas/AreaType' required: - areaType discriminator: propertyName: areaType mapping: CIRCLE: '#/components/schemas/Circle' SubscriptionDetailRequest: description: The detail of the requested event subscription. type: object properties: device: $ref: '#/components/schemas/Device' area: $ref: '#/components/schemas/Area' required: - area Source: type: string format: uri-reference minLength: 1 description: "Identifies the context in which an event happened - be a non-empty `URI-reference` like:\n- URI with a DNS authority:\n * https://github.com/cloudevents\n * mailto:cncf-wg-serverless@lists.cncf.io\n- Universally-unique URN with a UUID:\n * urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66\n- Application-specific identifier:\n * /cloudevents/spec/pull/123\n * 1-555-123-4567\n" example: https://notificationSendServer12.supertelco.com Subscription: description: Represents a event-type subscription. type: object required: - sink - protocol - config - types - id - startsAt 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: As of now we enforce to have only event type per subscription. ' type: array minItems: 1 maxItems: 1 items: $ref: '#/components/schemas/SubscriptionEventType' config: $ref: '#/components/schemas/ConfigResponse' id: 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: '1119920371' 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. ' 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. ' 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' ConfigRequest: allOf: - $ref: '#/components/schemas/Config' - description: 'Implementation-specific configuration parameters are needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`. Specific event type attributes requested by the client must be defined in `subscriptionDetail`. Note: If a request is performed for several event types, all subscribed events will use the same `config` parameters. ' type: object required: - subscriptionDetail properties: subscriptionDetail: $ref: '#/components/schemas/SubscriptionDetailRequest' ErrorInfo: description: The error info object for possible error cases. type: object required: - status - code - message properties: status: type: integer description: HTTP response status code. code: type: string description: A human-readable code to describe the error. message: type: string description: A human-readable description of what the event represents. SinkCredential: type: object description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target. properties: credentialType: type: string description: 'The type of the credential. Note: Type of the credential - MUST be set to ACCESSTOKEN for now ' enum: - PLAIN - ACCESSTOKEN - REFRESHTOKEN discriminator: propertyName: credentialType mapping: PLAIN: '#/components/schemas/PlainCredential' ACCESSTOKEN: '#/components/schemas/AccessTokenCredential' REFRESHTOKEN: '#/components/schemas/RefreshTokenCredential' required: - credentialType 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 DateTime: type: string format: date-time description: Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. example: '2018-04-05T17:31:00Z' Config: description: 'Implementation-specific configuration parameters are needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`. ' type: object properties: 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. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. 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. 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`. ' 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 request area entered event. If consumer sets initialEvent to true and device is already in the geofence, an event is triggered. ' Port: description: TCP or UDP port number. type: integer minimum: 0 maximum: 65535 Device: description: 'End-user device 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` NOTE1: the API provider might support only a subset of these options. The API consumer can provide multiple identifiers to be compatible across different API providers. In this case the identifiers MUST belong to the same 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 response or event. NOTE2: as for this Commonalities release, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines. ' 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 SubscriptionDetailResponse: description: The detail of the event subscription granted by the implementation. type: object properties: device: $ref: '#/components/schemas/DeviceResponse' area: $ref: '#/components/schemas/Area' required: - area Protocol: type: string enum: - HTTP - MQTT3 - MQTT5 - AMQP - NATS - KAFKA description: Identifier of a delivery protocol. Only HTTP is allowed for now. example: HTTP parameters: x-correlator: name: x-correlator in: header description: Correlation id for the different services. schema: $ref: '#/components/schemas/XCorrelator' SubscriptionId: name: subscriptionId in: path description: Subscription identifier that was obtained from the create event subscription operation. required: true schema: $ref: '#/components/schemas/SubscriptionId' responses: 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. 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. 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 - INVALID_CREDENTIAL - INVALID_PROTOCOL - INVALID_TOKEN - INVALID_SINK examples: GENERIC_400_INVALID_ARGUMENT: value: status: 400 code: INVALID_ARGUMENT message: Client specified an invalid argument, request body or query param. GENERIC_400_INVALID_PROTOCOL: value: status: 400 code: INVALID_PROTOCOL message: Only HTTP is supported. GENERIC_400_INVALID_CREDENTIAL: value: status: 400 code: INVALID_CREDENTIAL message: Only Access token is supported. GENERIC_400_INVALID_TOKEN: value: status: 400 code: INVALID_TOKEN message: Only bearer token is supported. GENERIC_400_INVALID_SINK: description: Invalid sink value value: status: 400 code: INVALID_SINK message: sink not valid for the specified protocol Generic400: description: Bad 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. 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: - MISSING_IDENTIFIER - MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED - SERVICE_NOT_APPLICABLE - UNNECESSARY_IDENTIFIER - UNSUPPORTED_IDENTIFIER - GEOFENCING_SUBSCRIPTIONS.AREA_NOT_COVERED - GEOFENCING_SUBSCRIPTIONS.INVALID_AREA examples: 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_MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED: value: status: 422 code: MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED message: Multi event types subscription not managed. 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_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. GEOFENCING_422_AREA_NOT_COVERED: summary: The area cannot be covered description: The system is not able cover the requested area value: status: 422 code: GEOFENCING_SUBSCRIPTIONS.AREA_NOT_COVERED message: Unable to cover the requested area GEOFENCING_422_INVALID_AREA: summary: Invalid area description: The requested area is too small to be supported by the system. value: status: 422 code: GEOFENCING_SUBSCRIPTIONS.INVALID_AREA message: The requested area is too small Generic401: description: Unauthorized 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 examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated and a new authentication is required value: status: 401 code: UNAUTHENTICATED message: Request not authenticated due to missing, invalid, or expired credentials. A 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. SubscriptionIdRequired: 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: summary: Schema validation failed value: status: 400 code: INVALID_ARGUMENT message: Client specified an invalid argument, request body or query param. GENERIC_400_SUBSCRIPTION_ID_REQUIRED: summary: The subscription id is required value: status: 400 code: INVALID_ARGUMENT message: 'Expected property is missing: subscriptionId' Generic404: description: 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. headers: x-correlator: description: Correlation id for the different services. schema: $ref: '#/components/schemas/XCorrelator' securitySchemes: openId: description: to support Consent Management type: openIdConnect openIdConnectUrl: https://example.com/.well-known/openid-configuration externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/CallForwardingSignal