Cellular Networks (Beta)

Principle

Cellular network management APIs allows user to retrieve connectivity information from Orange connectivity management provider. Once the customer account is configured information such as last network attachment, locations, session history, etc. can be retrieved. Retrieved information can vary depending on your provider, region and offer package account.

Providers

As of today, the only provider available is Orange Malima for the following regions :

Provider Available region

Malima

France, Spain, Poland, Romania, Slovakia

List cellular networks providers (Beta)

Request

Endpoint:

GET /api/v1/networks/cellular/providers

HTTP Headers:

X-API-Key: <your API key>
Accept: application/json

Example:

GET /api/v1/networks/cellular/providers

Response

HTTP Code:

200 OK

Body:

[
    {
        "id": "63ea4f8aba4c826792df04b8",
        "type": "malima",
        "configuration": {
            "cen": "mycen",
            "instanceId": "OFR"
        },
        "accountName" : "ZZZ My Account Name"
    }
]
JSON Params Description

id

Provider unique identifier

type

Provider type. Allowed values: [malima]

configuration

Provider customer account configuration

accountName

Provider account name

Error case:

HTTP Code Error code message

400

GENERIC_INVALID_PARAMETER_ERROR

The submitted parameter is invalid.

403

FORBIDDEN

Forbidden request

Subscriptions

A subscription is a network subscription identified by a subscriptionId. A subscription is linked to a SIM card and contains information such as :

  • The last network interaction

  • Attached device

  • Provider account subscription’s

  • SIM card capabilities and ids

Search cellular networks subscriptions (Beta)

Request

Endpoint:

POST /api/v1/networks/cellular/subscriptions/search

HTTP Headers:

X-API-Key: <your API key>
Content-Type: application/json
Accept: application/json

Body:

JSON Params Description

type

Search type of the subscription, allowed types : "msisdn", "imei" or "deviceId"

If you use the "deviceId", Live Objects will look for potential 'imei' or 'msisdn' in your device inventory based on the following fields (in order) :

- "imei" property (Cf. properties in device inventory)

- "msisdn" property (Cf. properties in device inventory)

- "deviceId"

- "nodeId" of your device interfaces for SMS, LwM2M, MQTT or x-connector connectors

value

Search value of the subscription (max 269 characters)

Example:

POST /api/v1/networks/cellular/subscriptions/search
{
    "type" : "msisdn",
    "value" : "337000003543020"
}

Response

HTTP Code:

200 OK

Body:

[
    {
        "id": "06361404",
        "msisdn": "337000003543020",
        "imsi": "208017401123509",
        "sim": {
            "status": "ACTIVATED",
            "iccid": "89330129210007850940",
            "serialNumber": "2921000785092",
            "lastUpdate": "2021-02-03T09:45:35Z"
        },
        "device": {
            "imei": "352753093029773",
            "lastUpdate": "2021-02-03T09:45:35Z"
        },
        "provider": {
            "type": "malima",
            "configuration": {
                "cen": "mycen",
                "instanceId": "myInstanceId"
            },
            "accountName" : "ZZZ My Account Name",
            "link": "https://m2mexpress.fr.orange-business.com/mac/customer/fleet/details.do?subId=06361404&category=SIM"
        }
    }
]
JSON Params Description

id

subscription unique identifier

msisdn

Number uniquely identifying a subscription in a Global System for Mobile communications

imsi

International Mobile Subscriber Identity

sim

Sim of the subscription (Cf. Sim format)

device

Device of the subscription (Cf. Device format)

provider

Provider of the subscription (Cf. Provider format)

Error case:_

HTTP Code Error code message

400

GENERIC_INVALID_PARAMETER_ERROR

The submitted parameter is invalid.

403

FORBIDDEN

Forbidden request

404

CELLULAR_SUBSCRIPTION_NOT_FOUND

Subscription not found

Get cellular networks subscription (Beta)

Request

Endpoint:

GET /api/v1/networks/cellular/subscriptions/{subscriptionId}

HTTP Headers:

X-API-Key: <your API key>
Content-Type: application/json
Accept: application/json

Example:

GET /api/v1/networks/cellular/subscriptions/06361407

Response

HTTP Code:

200 OK

Body:

{
    "id": "06361404",
    "msisdn": "337000003543020",
    "imsi": "208017401123509",
    "sim": {
        "status": "ACTIVATED",
        "iccid": "89330129210007850940",
        "serialNumber": "2921000785092",
        "lastUpdate": "2021-02-03T09:45:35Z",
        "capabilities" : {
             "smartSim" : true
        }
    },
    "device": {
        "imei": "352753093029773",
        "lastUpdate": "2021-02-03T09:45:35Z"
    },
    "provider": {
        "type": "malima",
        "configuration": {
            "cen": "mycen",
            "instanceId": "myInstanceId"
        },
        "accountName" : "ZZZ My Account Name",
        "link": "https://m2mexpress.fr.orange-business.com/mac/customer/fleet/details.do?subId=06361404&category=SIM"
    },
    "network": {
        "status": "ONLINE",
        "radio": "4G",
        "lastUpdate": "2020-10-28T16:13:04Z",
        "mobileCountry": {
            "code": "208",
            "value": "France"
        },
        "mobileNetwork": {
            "code": "208-01",
            "value": "Orange"
        },
        "lastNetworkInteraction": "DATA"
    }
}
JSON Params Description

id

subscription unique identifier

msisdn

Number uniquely identifying a subscription in a Global System for Mobile communications

imsi

International Mobile Subscriber Identity

sim

Sim of the subscription (Cf. Sim format)

device

Device of the subscription (Cf. Device format)

provider

Provider of the subscription (Cf. Provider format)

network

Network of the subscription (Cf. Network format)


The format of the sim is the following:

JSON Params Description

status

Status of SIM : PRE_ACTIVATED, ACTIVATED, SUSPENDED, CANCELLED …​

iccid

Integrated Circuit Card Identifier

serialNumber

Serial Number of SIM

lastUpdate

Last update date of SIM

capabilities

SIM capabilities (Cf. Sim capabilities format)


The format of the sim capabilities is the following:

JSON Params Description

smartSim

true when SIM supervision localization is available


The format of the device is the following:

JSON Params Description

imei

International Mobile Equipment Identity

lastUpdate

Last update date of device


The format of the provider is the following:

JSON Params Description

type

Provider type. Allowed values: [malima]

configuration

Provider customer account configuration

accountName

Provider account name

link

link to access portal M2M


The format of the network is the following:

JSON Params Description

status

Status of the last network attachment: ONLINE or OFFLINE

radio

Radio type of network attachment: 2G, 3G, 4G, 5G or UNKNOWN

lastUpdate

Last update date of network attachment

mobileCountry

Mobile country (if any)

mobileNetwork

Mobile network (if any)

lastNetworkInteraction

Last interaction of network attachment: DATA or SMS

Error case:_

HTTP Code Error code message

400

GENERIC_INVALID_PARAMETER_ERROR

The submitted parameter is invalid.

403

FORBIDDEN

Forbidden request

404

CELLULAR_SUBSCRIPTION_NOT_FOUND

Subscription not found

Location

Last known location of the associated device can be retrieve. This location can be provided by network probes (only available for France) or with SmartSim location service (available for some regions).

Only available for some regions and depends on your network provider option package.

Get cellular networks location (Beta)

Request

Endpoint:

GET /api/v1/networks/cellular/subscriptions/{subscriptionId}/location

HTTP Headers:

X-API-Key: <your API key>
Content-Type: application/json
Accept: application/json

Example:

GET /api/v1/networks/cellular/subscriptions/06361407/location

Response

HTTP Code:

200 OK

Body:

{
    "lat": "44.8",
    "lon": "3.7",
    "accuracy": "120.0",
    "provider": "network",
    "lastUpdateTs": "2020-10-28T16:13:04Z",
    "link": "https://m2mexpress.fr.orange-business.com/mac/customer/fleet/deviceinfo/localization-details.do?subId=06361407"
}
JSON Params Description

lat

coordinate latitude

lon

coordinate longitude

accuracy

position accuracy in m

lastUpdateTs

date of the position

provider

provider of the location ("network" when supplied by network probes (only available for France) or "smart-sim" when supplied by SmartSim location service)

link

link to access the location tab on the service provider portal

Error case:_

HTTP Code Error code message

400

GENERIC_INVALID_PARAMETER_ERROR

The submitted parameter is invalid.

403

FORBIDDEN

Forbidden request

404

CELLULAR_SUBSCRIPTION_NOT_FOUND

Subscription not found

Traffic history

Provide an aggregated view of the session history of the subscription. Max history depth is 30 days.

Get cellular subscription traffic history (Beta)

Request

Endpoint:

GET /api/v1/networks/cellular/subscriptions/{subscriptionId}/traffic/history

HTTP Headers:

X-API-Key: <your API key>
Content-Type: application/json
Accept: application/json

Parameters:

HTTP Params Description

limit

(optional) limit the response to the last n elements in the "data" object. 1000> n> 0

interval

(optional) requested aggregation format, "1h"(one hour), "1d"(one day) or "1w"(one week).

timeZone

(optional) time zone for daily or weekly aggregation, with TZ database name ("UTC", "Europe/Paris") or UTC Offset ("-02:00", "%2B04:00").

Example:

GET /api/v1/networks/cellular/subscriptions/06361407/location?limit=1&interval=1h&timeZone=Europe/Paris

Response

HTTP Code:

200 OK

Body:

[
    {
      "dataIn": 1096,
      "dataOut": 1096,
      "smsIn": 5,
      "smsOut": 5,
      "timestamp": "2024-02-01T09:00:00+01:00"
    }
]
JSON Params Description

dataIn

Sim data traffic with device as target (in Bytes)

dataOut

Sim data traffic device originated (in Bytes)

smsIn

Sim SMS count with device as target

smsOut

Sim SMS count device originated

timestamp

date time of the beginning of the bucket interval (in UTC)

Error case:_

HTTP Code Error code message

400

GENERIC_INVALID_PARAMETER_ERROR

The submitted parameter is invalid.

403

FORBIDDEN

Forbidden request

404

CELLULAR_SUBSCRIPTION_NOT_FOUND

Subscription not found
Version 2026.7.0 • Updated date 2026-08-11 12:37:29 UTC