.wpb_animate_when_almost_visible { opacity: 1; }
CAMARA - Device Status Beta
The Device Status API provides programmable interface for developers to retrieve information about device subscription like roaming status

Getting started


The CAMARA Device Status API provides a standardized mechanism for getting mobile equipment connectivity status.

Subscribe to the API

You get the Authorization header credentials when you register your application on the Orange Developer Console.

API Authentication

HTTPS requests to the REST API are protected with 2-Legged OAuth. To learn more about how Orange Developer handles authentication, please refer to our documentation.

In short, you will use your Orange Developer Authorization header as authorization_header for the Basic authentication with Orange Developper.

curl -X POST \
-H "Authorization: {{ authorization_header }}" \
-d "grant_type=client_credentials" \

In response, you will get an access_token.

       "token_type": "Bearer",
       "access_token": "66AeYJF8eJQ...2SjkFg9LB1LePC",
       "expires_in": "3600"

Go up

API Description

Summary of resources

This API has one resource status. status provide in the response information about mobile equipment connectivity.

Summary of methods and URL

Use case of operationURL method
I want to retrieve connectivity information of a device from a MSISDN number, an external identifier or an IP (+port)POST "https://api.orange.com/connectivity/v0/status

Go up

Summary of request body parameters

ueIdAn object with four fields, each of them make possible to pass ueId in different format: externalId , msisdn, ipv4Addr and ipv6AddrSee below information on ueIdYes
uePortIf a public ipv4Addr is provided for the ueId object, the port allocated to the UE must also be specifiedstringNo
eventTypeDetermines the connectivity event to check its status, for now only "UE_ROAMING_STATUS" is supportedstringYes

Following table provide details about ueId:

externalIdstringExternal Identifier format of the GPSI
msisdnstringSubscriber number in E.164 format (starting with country code). Optionally prefixed with '+'
Ipv4AddrstringIPv4 address may be specified in form <address/mask>. If address we expect an IPv4 number in dotted-quad form Only this exact IP number will match the flow control rule. If address/mask - an IP number as above with a mask width of the form
Ipv6AddrstringIPv6 address, following IETF 5952 format, may be specified in form <address/mask>. If address, the /128 subnet is optional for single address (2001:db8:85a3:8d3:1319:8a2e:370:7344 or 2001:db8:85a3:8d3:1319:8a2e:370:7344/128). If address/mask, an IP v6 number with a mask (2001:db8:85a3:8d3::0/64 or 2001:db8:85a3:8d3::/64 )

Go up

Request mobile equipement status (from msisdn)

curl -X POST "https://api.orange.com/connectivity/v0/status"
-H "Authorization: Bearer {your access token}"
-H "Cache-Control: no-cache"  
-H 'accept: application/json'
-H 'Content-Type: application/json'
-d  '{
"ueId": {
    "msisdn": "41793834315"
"eventType": "UE_ROAMING_STATUS"
200 Contains information about current connectivity status
Content-Type: application/json
"ueId": {
    "msisdn": "41793834315"
"eventType": "UE_ROAMING_STATUS",
"eventStatus": "ROAMING_ON"

Go up

Fields description

The response features the attributes provided in the request.

Additionally an attribute evenStatus valued either to ROAMING_ON or ROAMING_OFF provides device roaming status.

Go up

Most frequent errors

If invalid input are provided in particular for the ueId a 400 error is triggered.

HTTP/1.1 400 Invalid input
Content-Type: application/json
  "status": 400,
  "message": "Invalid input"

There are some cases where your client application will no longer gain access to API resources, and get an error back.

Please check the following points:

  • Here, you attempt to use an expired or revoked access_token and you get an invalid token error. You will have to request a new access_token. As an example:
HTTP/1.1 401 Unauthorized
Content-Type: application/json
  "status": 401,
  "message": "Authorization failed: ..."
  • Here, you removed your subscription to the API so that the capability to generate an access_token is not allowed anymore. As an example:
HTTP/1.1 403 Forbidden
Content-Type: application/json
  "status": 403,
  "message": "Operation not allowed: ..."

Go up

History of document

Version of the documentmodification datedescription of modifications
1.012/1/2023initialization by Orange CAMARA APIs team

Go up