---
title: "Create a device roaming status event subscription for a device"
method: POST
path: "/device-status/device-roaming-status-subscriptions/v0.7/subscriptions"
tags: ["Device Roaming Status Subscriptions v0.7"]
---

# Create a device roaming status event subscription for a device

`POST /device-status/device-roaming-status-subscriptions/v0.7/subscriptions`

Create a device roaming status event subscription for a device

## Headers

- `x-correlator` string
- `x-rapidapi-host` string, required

## Request body

- object — The request for creating a event-type event subscription
  - `protocol` 'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA', required — Identifier of a delivery protocol. Only HTTP is allowed for now
  - `sink` string, uri, required — The address to which events shall be delivered using the selected protocol.
  - `sinkCredential` object — A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
    - `credentialType` 'PLAIN' | 'ACCESSTOKEN' | 'REFRESHTOKEN', required — The type of the credential. Note: Type of the credential - MUST be set to ACCESSTOKEN for now
  - `types` string[], required — Camara Event types eligible to be delivered by this subscription. Note: for the current Commonalities version (v0.5) 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.
  - `config` object, required — 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.
    - `subscriptionDetail` object, required — The detail of the requested event subscription.
      - `device` object — End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide 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.
        - `phoneNumber` string — 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 '+'.
        - `networkAccessIdentifier` string — A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({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.
        - `ipv4Address` union — 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.
          - object
            - `publicAddress` string, ipv4, required — A single IPv4 address with no subnet mask
            - `privateAddress` string, ipv4, required — A single IPv4 address with no subnet mask
            - `publicPort` integer — TCP or UDP port number
          - object
            - `publicAddress` string, ipv4, required — A single IPv4 address with no subnet mask
            - `privateAddress` string, ipv4 — A single IPv4 address with no subnet mask
            - `publicPort` integer, required — TCP or UDP port number
        - `ipv6Address` string, ipv6 — 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).
    - `subscriptionExpireTime` string, date-time — The subscription expiration time (in date-time format) requested by the API consumer. Up to API project decision to keep it.
    - `subscriptionMaxEvents` integer — 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.
    - `initialEvent` boolean — 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 request Roaming event. If consumer sets initialEvent to true and device is in roaming situation, an event is triggered Up to API project decision to keep it.

## Response `201`

- object — Represents a event-type subscription.
  - `protocol` 'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA', required — Identifier of a delivery protocol. Only HTTP is allowed for now
  - `sink` string, url, required — The address to which events shall be delivered using the selected protocol.
  - `types` string[], required — Camara Event types eligible to be delivered by this subscription. Note: for the Commonalities meta-release v0.4 we enforce to have only event type per subscription then for following meta-release use of array MUST be decided at API project level.
  - `config` object, required — 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.
    - `subscriptionDetail` object, required — The detail of the requested event subscription.
      - `device` object — End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide 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.
        - `phoneNumber` string — 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 '+'.
        - `networkAccessIdentifier` string — A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({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.
        - `ipv4Address` union — 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.
          - object
            - `publicAddress` string, ipv4, required — A single IPv4 address with no subnet mask
            - `privateAddress` string, ipv4, required — A single IPv4 address with no subnet mask
            - `publicPort` integer — TCP or UDP port number
          - object
            - `publicAddress` string, ipv4, required — A single IPv4 address with no subnet mask
            - `privateAddress` string, ipv4 — A single IPv4 address with no subnet mask
            - `publicPort` integer, required — TCP or UDP port number
        - `ipv6Address` string, ipv6 — 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).
    - `subscriptionExpireTime` string, date-time — The subscription expiration time (in date-time format) requested by the API consumer. Up to API project decision to keep it.
    - `subscriptionMaxEvents` integer — 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.
    - `initialEvent` boolean — 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 request Roaming event. If consumer sets initialEvent to true and device is in roaming situation, an event is triggered Up to API project decision to keep it.
  - `id` string, required — 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).
  - `startsAt` string, date-time — 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)
  - `expiresAt` string, date-time — 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)
  - `status` 'ACTIVATION_REQUESTED' | 'ACTIVE' | 'EXPIRED' | 'INACTIVE' | 'DELETED' — 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).

## Other responses

- `202`
- `400`
- `401`
- `403`
- `409`
- `422`
- `429`

---

[API](https://skmtc.dev/nokia/apis/network-as-code.md) · [All operations](https://skmtc.dev/nokia/apis/network-as-code/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nokia/network-as-code/revisions/fdd5f5a56b88/schema)