Device Reachability Status - CAMARA Sandbox - Orange lab 0.1 Beta

Getting started

• Disclaimer (sandboxed version)
• Introduction
  • Subscribe to the API
  • API Authentication
  • API Description
    • Summary of resources
    • Summary of methods and URL
    • Summary of request body parameters
    • Request mobile equipement status (from msisdn)
      • Request
      • Response
      • Fields description
    • Most frequent errors
• Looking for support ?
• History of document

Disclaimer (sandbox version)

This CAMARA Sandbox - Device Reachability Status - Orange lab API is a sandbox version of the CAMARA - Device Reachability Status API.

It is running in our lab, against a small list of lab-specific mobile devices (see list of phone number available for test below).

This API could be suspended or upgraded any time without any notice.

Introduction

The CAMARA Device Reachability Status API provides a standardized mechanism for getting mobile equipment Reachability status (connectivity status of the device).

Subscribe to the API

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

API Authentication

Note: In production environment the Device Roaming Status API will require a 3-Legged OAuth 2.0 flow but as this implementation is provided on Orange Lab, the API works with a 2-Legged OAuth (OAuth 2 with client credentials).

Sum-up:

• url to get the token is: https://api.orange.com/oauth/v3/token
• grant type: client credentials
• token prefix: Bearer

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 Developer.

curl -X POST \
-H "Authorization: {{ authorization_header }}" \
-d "grant_type=client_credentials" \
https://api.orange.com/oauth/v3/token

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 connectivity. In the response, the connectivity status of the mobile line is provided (reachable by Data, SMS or not reachable).

Summary of methods and URL

Go up

Summary of request body parameters

Following table provide details about device:

Lab implementation specific:

Only requests using phoneNumber are operational. Following phone number must be used (other will not work):

Note: Do not forget to add + prefix

Example of body query

{
"device": {
    "phoneNumber": "+33699901064"
   }
}

Go up

Request mobile equipment status (from phone number)

Request

curl -X POST "https://api.orange.com/camara/orange-lab/device-reachability-status/v0/retrieve"
-H "Authorization: Bearer {your access token}"
-H "Cache-Control: no-cache"  
-H 'accept: application/json'
-H 'Content-Type: application/json'
-d  '{
"device": {
    "phoneNumber": "+33699901064"
  }
}

Response

200 OK
Content-Type: application/json

{
  "lastStatusTime": "2024-02-20T10:41:38.657Z",
  "reachabilityStatus": "CONNECTED_DATA"
}

Go up

Fields description

In the response following attributes are provided:

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
{
  "code": "INVALID_ARGUMENT",
  "status": 400,
  "message": "Invalid input"
}

if a non-managed msisdn is provided a 500 error is triggered.

HTTP/1.1 500 Internal Server Error
Content-Type: application/json
{
  "status": 500,
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal Server Error, status code 500"
}

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
{
  "code": "UNAUTHENTICATED",
  "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
{
  "code": "PERMISSION_DENIED",
  "status": 403,
  "message": "Operation not allowed: ..."
}

Looking for support ?

Facing technical issue when using this API ? please contact us

Go up

History of document

Go up