Getting started
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).
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 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"
}
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
Use case of operation | URL method |
---|---|
I want to get connectivity information of a device from a MSISDN number, an external identifier or an IP (+port) | POST "https://api.orange.com/camara/orange-lab/device-reachability-status/v0/retrieve" |
Summary of request body parameters
Name | Description | Type | Mandatory |
---|---|---|---|
device | An object with four fields, each of them make possible to pass device identifier in different format: externalId , msisdn, ipv4Addr and ipv6Addr | See below information on device | No |
Following table provide details about device:
Name | Type | Description |
---|---|---|
externalId | string | External Identifier format of the GPSI. Not managed in our implementation |
phoneNumber | string | Subscriber number in E.164 format (starting with country code). Must be prefixed with '+' |
Ipv4Addr | string | IPv4 address may be specified in form <address/mask>. If address we expect an IPv4 number in dotted-quad form 1.2.3.4. 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 1.2.3.4/24. Not managed in our implementation |
Ipv6Addr | string | IPv6 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 ). Not managed in our implementation |
Lab implementation specific:
Only requests using phoneNumber
are operational. Following phone number must be used (other will not work):
msisdn |
---|
33699901031 |
33699901032 |
33699901033 |
33699901034 |
33699901035 |
33699901036 |
33699901037 |
33699901038 |
33699901039 |
33699901040 |
33699901064 |
Example of body query
{
"device": {
"phoneNumber": "+33699901064"
}
}
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"
}
Fields description
In the response following attributes are provided:
Name | Type | Description | Mandatory |
---|---|---|---|
reachabilityStatus | string | Last time that the associated device reachability status was updated | Yes |
lastStatusTime | string(datetime) | connectivity status of the device - could be: CONNECTED_DATA: The device is connected to the network for Data usage, CONNECTED_SMS: The device is connected to the network for SMS usage, NOT_CONNECTED: The device is not connected | Yes |
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
History of document
Version of the document | modification date | description of modifications |
---|---|---|
1.0 | 19/08/2024 | initialization by Orange CAMARA APIs team |