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 |