Device connectivity

The Device Status feature allows querying and reporting information on several aspects of data connectivity for a device, so you can monitor its status updates, such as when it goes online or offline.

Subscribe to Connectivity Status eventsheader link

The SDK below allows you to subscribe client devices to Device Status connectivity events.

import network_as_code as nac
from network_as_code.models.device_status import EventType
from datetime import datetime, timedelta, timezone

# We begin by creating a Network as Code client
client = nac.NetworkAsCodeClient(
    token="<your-application-key-here>"
)
# Then, we create an object for the mobile device we want to use
my_device = client.devices.get(
    # The phone number does not accept spaces or parentheses
    phone_number="+99999991000"
)

# Then we subscribe your device to connectivity events.
my_subscription = client.connectivity.subscribe(
    event_type=EventType.CONNECTIVITY_DATA,
    device=my_device,
    # You can tell when the subscription is supposed to expire with datetime
    subscription_expire_time=datetime.now(timezone.utc) + timedelta(days=1),
    # Use HTTPS to send notifications
    notification_url="https://example.com/notifications",
    notification_auth_token="replace-with-your-auth-token"
)

# Use this to show the connectivity subscription status
print(my_subscription)

Connectivity subscription parametersheader link

Connectivity event typesheader link

Simulated Device Connectivity scenariosheader link

The Network as Code simulators have been configured to provide specific device connectivity results for specific simulated devices based on their device identifier. This will be helpful in testing your code against the different responses, including possible errors, by simply substituting the device identifier in your code.

The device identifiers and their responses can be found in the following table:

Getting a device connectivity statusheader link

You can check the device connectivity status like so:

  print(my_device.get_connectivity())

Getting device connectivity status responsesheader link

Getting connectivity notificationsheader link

The code snippet below will set up an HTTP server with a POST endpoint. This will allow receiving device connectivity status updates. For example, you can learn if a device is available (connected to the network) or not. Learn more about the notification URL/auth token and how to create an HTTP server with a POST endpoint for connectivity notifications.

Connectivity notification handlerheader link

# status_handler.py for CONNECTIVITY

# run with: uvicorn status_handler:app

from fastapi import FastAPI, Header
from pydantic import BaseModel

from typing_extensions import Annotated
from typing import Union, Optional


app = FastAPI()

class Device(BaseModel):
    phoneNumber: Optional[str] | None
    networkAccessIdentifier: Optional[str] | None
    ipv4Address: Optional[str] | None
    ipv6Address: Optional[str] | None

class ConnectivityEventDetail(BaseModel):
    device: Device
    subscriptionId: str
    deviceStatus: str
    terminationReason: str

class Event(BaseModel):
    eventType: str
    eventTime: str
    eventDetail: ConnectivityEventDetail

class Data(BaseModel):
    device: Device
    subscriptionId: str
    terminationReason: str

class Notification(BaseModel):
    id: str
    source: str
    type: str
    specversion: str
    datacontenttype: str
    time: str
    eventSubscriptionId: str
    event: Event
    data: Data

@app.post("/notifications")
def receive_notification(
    notification: Notification,
    authorization: Annotated[Union[str, None], Header]
):
    if authorization == "Bearer my-token":
        # We can now react to the notifications
        # based on the Notification object
        print(notification)

Connectivity notification detailsheader link

This notification JSON schema is used for notifications about device connectivity.

Remember that the string values represented below are just examples that can be used. So, they should contain your real device-status values.

{
    "id": "9884b8d2-5392-4ed7-8cde-0ce25bf58df3",
    "source": "/device-status/v0/subscriptions/83b1eaae-4533-4bff-a0af-e805cb8a2940",
    "type": "org.camaraproject.device-status.v0.connectivity-data",
    "specversion": "1.0",
    "datacontenttype": "application/json",
    "time": "2026-04-17T07:31:01.416474Z",
    "data": {
        "device": {
            "phoneNumber": "+99999991000",
            "networkAccessIdentifier": "[email protected]",
            "ipv4Address": {
                "publicAddress": "233.252.0.2",
                "privateAddress": "192.0.2.25",
                "publicPort": 80
            },
            "ipv6Address": "2001:db8:1234:5678:9abc:def0:fedc:ba98"
        },
        "subscriptionId": "83b1eaae-4533-4bff-a0af-e805cb8a2940"
    }
}

Shared-keyword valuesheader link

Check the table below for further information on mandatory, optional values and their types. The values described here are common to all the Device-Status notification JSON schemas:

Device identifiersheader link

Last updated November 05, 2025