.jpg)
14. Endpoint
14. Endpoint
This page contains all documentation under this Postman category.
Additional usage notes
planId should be sourced via GET Query Rate Plan.
serviceProfileId should be sourced via GET Service Profile.
apnGroupId should be sourced via GET APN Group.
simProductId should be sourced from the SIM Product IDs section / GET SIM Product.
endpointId should be sourced via GET Endpoint or from the Create Endpoint response.
Endpoints represent SIM-based assets in the SFT platform.
Create Endpoint is one of the APIs with extended timeout of 180 seconds.
Link SIM and De-Link SIM are APIs with extended timeout of 180 seconds.
Endpoint Activation and Endpoint Lifecycle Change are APIs with extended timeout of 180 seconds.
Enterprise Only!!
Please have in mind that the APIs under Endpoint can be used only by Enterprise accounts. Other type of accounts, like a Reseller, dont have access to entpoint information and thus the API will fail with an "Authorisation Failure" message
Endpoint - Create
Path: Endpoint / Endpoint - Create
Method: POST
URL: https://sft.bics.com/api/CreateEndPoint
Description
This API is used to Create Endpoint, Link SIM (Optional) and Activation (Optional) in a single step. So the endpoint will be activated in the network and the SIM will be in the ready to use state. NOTE: For OEM enabled accounts endpoints will be created to Active-Test state initially
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
requestParam | M | Object of End Point details |
Input requestParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
name | M | Name of the End Point |
isLinkSIM | M | SIM to be linked or not (true/false) |
roamingProfileId | M | Roaming profile Ids to be attached. Multiple id’s can be attached using pipe separators |
apnGroupId | M | APN Group ID, You can fetch the list of possible apnGroupId using "fetchApnGroup" API. |
planId | M | Plan Reference, You can fetch the list of possible planId using "QueryRatePlan" API. |
iccid | CM | ICCID of the SIM to be linked if isLinkSIM is true |
isDefaultActivation | M | SIM to be activated or not (true/false) |
monthlyLimit | O | Monthly Limit |
dynamicBenefitEnable | O | This parameter has become deprecated. It will be ignored by the system if sent. Subscription of an Endpoint to Dynamic Benefits is only mandatory if “dynamicBenefitEnable” is true on account level and only when the Endpoint is activated. |
benefits | CM | Pooled or non-pooled Dynamic Benefit ID, mandatory if "dynamicBenefitEnable" on account level is true and if the Endpoint is activated, optional otherwise. You can fetch the list of possible benefitIds using the "GetCustomerProfile" API. |
imeiLockStatus | O | Imeilock status for an endpoint values: <br>LOCK <br>UNLOCK |
imei | O | IMEI of the account |
addonPlanIds | O | Plan id of addon plans which needs to be activated into the account, You can fetch the list of possible planId using "QueryRatePlan" API. <br>Note: This parameter will work only if "isDefaultActivation":"true". <br>Format for the addon Plan id should be like ["addonPlanId1","addonPlanId2"] |
valueAddedFeatureIds | O | IDs of value added features which need to be activated for the endpoint <br>Format should be like ["valueAddedFeatureId1","valueAddedFeatureId2"] <br>The exact values of the IDs can be retrieved from the value added features configured in the platform |
tagIds | O | List of TAG IDs (comma separated and within double quote) to be assigned to endpoint. See examples for more info. <br>(Maximum 10 tag's can be add to endpoint) |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
endPointId | O | Unique ID of the End Point which will be created and will be returned in the response |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
5014 | SIM provisioning success | |
6409 | Link SIM success | |
6411 | Create endpoint success | |
6412 | Create endpoint failure | |
6722 | MSISDN not exist | |
7022 | Customer is in low balance provisioning not allowed | |
10023 | Addon planID does not belong to the billing type | |
10073 | Maximum count exceeds for input parameter - {reason} | Based on the input parameter from the request ,the reason for this error code will differ. For example, if we are trying to add more than 15 addon plans for a single endpoint we will get this error code saying that Maximum count exceeds for input parameter - addAddonPlanIds,value |
10077 | Maximum Benefit limit Reachecd | |
10093 | Service not available for the subscribing plan | |
10140 | ICCID not available | |
10201 | The option Dynamic Benefit only is enabled at parent level. Please subscribe the endpoint to a pooled or non-pooled dynamic benefit. | |
10080 | Addon PlanID does not belong to the roaming profile | Crete a new Addon plan with same roaming profile which used for base plan, (Attached to the endpoint) and then re-try. |
10120 | Maximum number of tag is reached | |
10200 | Coverage of the selected dynamicbenefit does not match with this endpoint's roamingprofile meaning the endpoint would not be able to use any of the benefits provided. Please select a dynamic benefit with matching coverage | |
10221 | Duplicate addon plans are not allowed | |
10239 | Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not. | |
10240 | Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not. |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"requestParam":{
"name":"Endpointname3",
"apnGroupId":"PDP_1002",
"roamingProfileId":"2",
"isLinkSIM":"true",
"iccid":"8932042000000010297",
"isDefaultActivation":"true",
"planId":"560077",
"monthlyLimit":"1000",
"tagIds":["1001","1002","1003"]
}
}
}Response Examples
Create EndPoint Single - Failure - {Duplicate IMSI}
{
"Response": {
"responseId": "39156722926445907",
"responseTimestamp": "12/05/2020 12:12:53",
"resultCode": "1",
"resultParam": {
"resultCode": "2026",
"resultDescription": "Duplicate IMSI"
}
}
}Create EndPoint - Single - Success - {Sample for Dynamic Benefit}
{
"Response": {
"responseId": "39156566764835489",
"responseTimestamp": "12/05/2020 12:10:16",
"resultCode": "0",
"resultParam": {
"resultCode": "6411",
"resultDescription": "Create Endpoint Success"
},
"endPointId": "51079188"
}
}Create EndPoint Single - Success - {Endpoint Creation Only} — 200 — OK
{
"Response": {
"responseId": "39156566764835489",
"responseTimestamp": "12/05/2020 12:10:16",
"resultCode": "0",
"resultParam": {
"resultCode": "6411",
"resultDescription": "Create endpoint success"
},
"endPointId": "51079186"
}
}Create EndPoint Single - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "6412",
"resultDescription": "Create endpoint failure"
}
}
}Create EndPoint Single - Success - {Link SIM} — 200 — OK
{
"Response": {
"responseId": "39156495928076158",
"responseTimestamp": "12/05/2020 12:09:06",
"resultCode": "0",
"resultParam": {
"resultCode": "6409",
"resultDescription": "Link SIM success"
},
"endPointId": "51079185"
}
}Create EndPoint Single - Failure - {Customer is in Low Balance}
{
"Response": {
"responseId": "39158031186858047",
"responseTimestamp": "12/05/2020 12:34:42",
"resultCode": "1",
"resultParam": {
"resultCode": "7022",
"resultDescription": "Customer is in low balance provisioning not allowed"
}
}
}Create EndPoint Single - Success - {All Parameters}
{
"Response": {
"responseId": "2021997715791753",
"responseTimestamp": "04/07/2020 07:10:07",
"resultCode": "0",
"resultParam": {
"resultCode": "5014",
"resultDescription": "Sim provisioning success"
},
"endPointId": "51238993"
}
}Create Endpoint Single - Failure
{
"Response": {
"responseId": "6054289446088997",
"responseTimestamp": "19/12/2022 12:08:40",
"resultCode": "1",
"resultParam": {
"resultCode": "10201",
"resultDescription": "The option Dynamic Benefit only is enabled at parent level. Please subscribe the endpoint to a pooled or non-pooled dynamic benefit."
}
}
}Endpoints
Path: Endpoint / Endpoints
Method: GET
URL: https://sft.bics.com/api/GetEndpoints
Description
This API is used to fetch the End Points for the account and supports pagination (see below for details).
If it is fired without any query parameters, the full list of endpoints will be returned.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input QUERY PARAMETERS
Field | Optional/ Mandatory | Description |
|---|---|---|
page | O | Page parameter describes for which page the records are fetched |
perPage | O | Per page parameter describes the total records expected in a page. Maximum number of records in a page is 2000 |
tagId | O | tagId= <br> <br>used to fetch all endpoints that have the specific tag Id assigned <br> <br>IF used as tagid=null it should fetch all endpoints that don’t any tag Id assigned to them |
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
resultCode | M | API result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated timeFormat: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
responseParam | O | Object of endpoint details |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code. |
resultDescription | M | Status/Error Description. |
Output responseParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
endpoints | O | List of Endpoint Details |
Output endpoints Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
status | O | Status of Endpoint <br>A – Active <br>S – Suspend <br>H – Hold <br>PA – Pre-active <br>AT - Active-Test (Available only for OEM enable accounts) <br>AI - Active-Inventory (Available only for OEM enable accounts) |
id | O | ID of Endpoint, this parameter is the same with parameter EndpointID |
name | O | Name of Endpoint |
iccid | O | ICCID of the SIM, if SIM is attached to Endpoint |
imei | O | IMEI of the SIM, if SIM is attached to Endpoint |
type | O | Type of Endpoint <br>0 – Prepaid <br>1 – Postpaid |
msisdn | O | MSISDN, if SIM is activated |
imeiLockStatus | O | Value should be either LOCK/UNLOCK |
imsi | O | IMSI of the SIM, if SIM is attached to Endpoint |
eid | O | EID of the SIM, if SIM is attached to Endpoint |
tagIdList | O | Tag details, if tag attached to endpoint |
OUTPUT TAGIDLIST PARAMETERS
Field | Optional/ Mandatory | Description |
|---|---|---|
tagName | O | Name of the tag |
tagId | O | Tag id |
tagDescription | O | Tag description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
6742 | Fetch endpoints success | |
6745 | Fetch endpoints failure |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Response Examples
Get Endpints - Success {Specific - Number of Pages and Per page}
{
"Response": {
"responseId": "294839176672474",
"responseTimestamp": "31/08/2021 05:24:09",
"resultCode": "0",
"resultParam": {
"resultCode": "6742",
"resultDescription": "Fetch endpoints success"
},
"responseParam": {
"endpoints": [
{
"status": "A",
"id": "51175551",
"name": "NewEndpoint",
"iccid": "9990000000000011461",
"imei": "172938712893782",
"msisdn": "329999800011461",
"imsi": "999980000011461",
"type": "0",
"imeiLockStatus": "UNLOCK",
"tagIdList":[
{
"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
},
{
"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
}
]
},
{
"status": "A",
"id": "51175552",
"name": "endpointBulk_1",
"iccid": "9990000000000011462",
"msisdn": "329999800011462",
"imsi": "999980000011462",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175553",
"name": "endpointBulk_2",
"iccid": "9990000000000011463",
"msisdn": "329999800011463",
"imsi": "999980000011463",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175554",
"name": "endpointBulk_3",
"iccid": "9990000000000011464",
"msisdn": "329999800011464",
"imsi": "999980000011464",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175555",
"name": "endpointBulk_4",
"iccid": "9990000000000011465",
"msisdn": "329999800011465",
"imsi": "999980000011465",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175556",
"name": "endpointBulk_5",
"iccid": "9990000000000011466",
"msisdn": "329999800011466",
"imsi": "999980000011466",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175557",
"name": "endpointBulk_6",
"iccid": "9990000000000011467",
"msisdn": "329999800011467",
"imsi": "999980000011467",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175558",
"name": "endpointBulk_7",
"iccid": "9990000000000011468",
"msisdn": "329999800011468",
"imsi": "999980000011468",
"type": "0",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175559",
"name": "endpointBulk_8",
"iccid": "9990000000000011469",
"msisdn": "329999800011469",
"imsi": "999980000011469",
"type": "0",
"imeiLockStatus": "LOCK"
}
]
},
"totalNoOfRecords": "106",
"totalNoOfPages": "12"
}
}Get EndPoints - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "6745",
"resultDescription": "Fetch endpoints failure"
}
}
}Get EndPoints - Success — 200 — OK
{
"Response": {
"responseId": "294839176672474",
"responseTimestamp": "14/06/2020 05:24:09",
"resultCode": "0",
"resultParam": {
"resultCode": "6742",
"resultDescription": "Fetch endpoints success"
},
"responseParam": {
"endpoints": [
{
"status": "A",
"id": "51175551",
"name": "NewEndpoint",
"iccid": "9990000000000011461",
"imei": "172938712893782",
"msisdn": "329999800011461",
"imsi": "999980000011461",
"type": "0",
"eid":"-",
"imeiLockStatus": "UNLOCK"
},
{
"status": "A",
"id": "51175552",
"name": "endpointBulk_1",
"iccid": "9990000000000011462",
"msisdn": "329999800011462",
"imsi": "999980000011462",
"type": "0",
"eid":"-",
"imeiLockStatus": "LOCK",
"tagIdList":[
{
"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
},
{
"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
}
]
},
{
"status": "A",
"id": "51175553",
"name": "endpointBulk_2",
"iccid": "9990000000000011463",
"msisdn": "329999800011463",
"imsi": "999980000011463",
"type": "0",
"eid":"99000023354170000000001234560041",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175554",
"name": "endpointBulk_3",
"iccid": "9990000000000011464",
"msisdn": "-",
"imsi": "-",
"type": "0",
"eid":"99213360886673124896165251814999",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175555",
"name": "endpointBulk_4",
"iccid": "9990000000000011465",
"msisdn": "329999800011465",
"imsi": "999980000011465",
"type": "0",
"eid":"-",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175556",
"name": "endpointBulk_5",
"iccid": "9990000000000011466",
"msisdn": "329999800011466",
"imsi": "999980000011466",
"type": "0",
"eid":"-",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175557",
"name": "endpointBulk_6",
"iccid": "9990000000000011467",
"msisdn": "329999800011467",
"imsi": "999980000011467",
"type": "0",
"eid":"-",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175558",
"name": "endpointBulk_7",
"iccid": "9990000000000011468",
"msisdn": "329999800011468",
"imsi": "999980000011468",
"type": "0",
"eid":"-",
"imeiLockStatus": "LOCK"
},
{
"status": "A",
"id": "51175559",
"name": "endpointBulk_8",
"iccid": "9990000000000011469",
"msisdn": "329999800011469",
"imsi": "999980000011469",
"type": "0",
"eid":"-",
"imeiLockStatus": "LOCK"
}
]
}
}
}Get EndPoints - Success {For endpoints in Active-Test, Active-Inventory states}
{
"Response": {
"responseId": "3016402848308864",
"responseTimestamp": "30/12/2020 10:20:22",
"resultCode": "0",
"resultParam": {
"resultCode": "6742",
"resultDescription": "Fetch endpoints success"
},
"responseParam": {
"endpoints": [
{
"status": "AT",
"id": "51596269",
"name": "TestEndpoint",
"iccid": "9990000000000010022",
"msisdn": "329999800010022",
"imsi": "999980000010022",
"type": "1",
"imeiLockStatus": "LOCK",
"tagIdList":[
{
"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
},
{
"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
}
]
},
{
"status": "A",
"id": "51596295",
"name": "test_Endpoint2",
"iccid": "9990000000000010028",
"msisdn": "329999800010028",
"imsi": "999980000010028",
"type": "0",
"imeiLockStatus": "UNLOCK"
},
{
"status": "AI",
"id": "51596268",
"name": "test_Endpoint3",
"iccid": "9990000000000010023",
"imei": "5533",
"msisdn": "329999800010023",
"imsi": "999980000010023",
"type": "1",
"imeiLockStatus": "UNLOCK"
},
{
"status": "H",
"id": "51596265",
"name": "test_Endpoint4",
"type": "1",
"imeiLockStatus": "LOCK"
}
]
}
}
}Get EndPoints - Success {For tagId}
{
"Response": {
"responseId": "9063342821928060",
"responseTimestamp": "28/09/2022 04:56:28",
"resultCode": "0",
"resultParam": {
"resultCode": "6742",
"resultDescription": "Fetch endpoints success"
},
"responseParam": {
"endpoints": [
{
"status": "A",
"id": "51716214",
"name": "test_taga",
"iccid": "8932042000000000010",
"msisdn": "327700040900010",
"imsi": "206281000000010",
"type": "1",
"imeiLockStatus": "UNLOCK",
"tagIdList": [
{
"tagName": "Tag_demo1",
"tagId": "2845001",
"tagDescription": "bics_belgium A"
}
]
}
]
},
"totalNoOfRecords": "17",
"totalNoOfPages": "1"
}
}Get EndPoints - Success {For Null}
{
"Response": {
"responseId": "9063363486144516",
"responseTimestamp": "28/09/2022 04:56:49",
"resultCode": "0",
"resultParam": {
"resultCode": "6742",
"resultDescription": "Fetch endpoints success"
},
"responseParam": {
"endpoints": [
{
"status": "PA",
"id": "51714881",
"name": "new_endpoint:_only_creation",
"msisdn": "",
"type": "1",
"imeiLockStatus": "UNLOCK"
},
{
"status": "H",
"id": "51714431",
"name": "test_0098",
"msisdn": "",
"type": "1",
"imeiLockStatus": "UNLOCK"
},
{
"status": "H",
"id": "51714432",
"name": "test_Tags_1",
"msisdn": "",
"type": "1",
"imeiLockStatus": "UNLOCK"
},
{
"status": "H",
"id": "51714399",
"name": "bulk_tags_1",
"msisdn": "",
"type": "1",
"imeiLockStatus": "UNLOCK"
}
]
},
"totalNoOfRecords": "4",
"totalNoOfPages": "1"
}
}Endpoint - Modify
Path: Endpoint / Endpoint - Modify
Method: PATCH
URL: https://sft.bics.com/api/endpoint
Description
This API is used to Modify the end point details.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | CM | EndPointID for which modification needs to be done, Mandatory if IMSI/MSISDN/ICCID is not given |
imsi | CM | IMSI for which modification needs to be done, Mandatory if endPointID/MSISDN/ICCID is not given |
msisdn | CM | MSISDN for which modification needs to be done, Mandatory if the endPointID/IMSI/ICCID is not given |
iccid | CM | ICCID for which modification needs to be done, Mandatory if the endPointID/IMSI/MSISDN is not given |
requestParam | M | Object of request details |
Input requestParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
imeiLockStatus | O | Imeilock status for an endpoint values: LOCK UNLOCK |
imei | O | IMEI number to be locked. <br>This can be given when the endpoint is being unlocked/locked. Use Lock/Unlock with imei = "" to remove previous imei value. |
addAddonPlanIds | O | List of Addon plan IDs to be added. List is limited to maximum 10 addons IDs per API Call. <br>Note that the maximum number of addons that can be subscribed at any given time to an endpoint is 15. <br>You can fetch the list of possible planId using "QueryRatePlan" API. <br>NOTE:For OEM enabled accounts addition of Addon is allowed when the endpoint is in Active-Test or Active-Inventory state.But addon will be activated and visible only after its status is changed to Active |
removeAddonUniqueIds | O | List of Addons Unique IDs to be removed, You can fetch the list of possible uniqueId using "GetEndPointProfile" API. <br>NOTE:For OEM enabled accounts deletion of addon with UniqueId is not possible. |
addValueAddedFeatureIds | O | IDs of value added features which need to be activated for the endpoint <br>Format should be like ["valueAddedFeatureId1","valueAddedFeatureId2"] <br>The exact values of the IDs can be retrieved from the value added features configured in the platform |
removeValueAddedFeatureIds | O | IDs of value added features which need to be removed for the endpoint <br>Format should be like ["valueAddedFeatureId1","valueAddedFeatureId2"] <br>The exact values of the IDs can be retrieved from the value added features configured in the platform |
addDynamicBenefitsIds | O | List of pooled or non-pooled Dynamic Benefits IDs to subscribe the Endpoint to. Currently an Endpoint can be subscribed only to one pooled or non-pooled Dynamic Benefits <br>You can fetch the list of IDs of available Dynamic Benefits IDs using the "GetCustomerProfile" API. <br>NOTE:For OEM enabled accounts addition of Dynamicbenefit is allowed when the endpoint is in Active-Test or Active-Inventory state.But Dynamicbenefit will be activated and visible only after its status is changed to Active |
removeDynamicBenefitsIds | O | List of pooled or non-pooled Dynamic Benefits IDs to unsubscribe the Endpoint from. A subscription to pooled or non-pooled Dynamic Benefits is mandatory if “dynamicBenefitEnable” is true on account level and if the Endpoint is activated. <br>You can fetch the ID of the currently subscribed Dynamic Benefits using the "GetEndpointProfile" API. |
addtagIds | O | List of TAG IDs (comma separated and within double quote) to be added to endpoint. |
removetagIds | O | List of TAG IDs (comma separated and within double quote) to be removed to endpoint. |
removeAddonPlanIds | O | List of Addon plan IDs to be removed from OEM endpoint (ActiveTest/ActiveInventory). |
endPointName | O | New endpoint Name <br>can have <br>minimum of 5 characters, maximum of 30 characters, it can be alphanumeric, it can have space, colon and underscore. |
bar_2G | O | True <br>False <br>bar/unbar 2G |
bar_2G/3G | O | True <br>False <br>bar/unbar 2G/3G |
bar_4G | O | True <br>False <br>bar/unbar 4G |
bar_5G | O | True <br>False <br>bar/unbar 5G |
bar_SMS_MT | O | True <br>False <br>bar/unbar SMS_MT |
bar_SMS_MO | O | True <br>False <br>bar/unbar SMS_MO |
bar_DATA | O | True <br>False <br>bar/unbar DATA |
bar_NB_IOT | O | True <br>False <br>bar/unbar NB_IOT |
bar_All_Services | O | True <br>False <br>(1. if "bar_All_Services" is present rest all the barred parameters should be skipped. <br> <br>2. "bar_All_Services" will bar only services belongs to their Service Profile. If the Service Profile includes all the 4 services all the 4 below services will be barred) |
apnGroupId | O | APN Group ID, You can fetch the list of possible apnGroupId using "fetchApnGroup" API |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | API result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10068 | Modify endpoint success | |
10069 | Modify endpoint failure | |
2503 | Subscriber not in active state | |
10199 | Your request is under process | |
10202 | One deactivate addon request is under process | |
1013 | Already Deactivated(Addon deactivate) | |
10145 | The option Dynamic Benefit only is enabled at parent level.So removing dynamic benefit is not possible | |
10147 | Request fails since same dynamic benefit is already assigned | |
10230 | Service already barred - DATA | |
10231 | Service already unbarred - DATA | |
10232 | Service is not present for endpoint - DATA | |
10233 | Unbarring RAT is not possible when DATA Service is already barred |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51175551",
"requestParam":{
"addAddonPlanIds":["pland103","pland104","pland155"],
"removeAddonPlanIds":["pland101","pland102"],
"addtagIds":["1001"],
"removetagIds":["1002"]
}
}
}Response Examples
Modify Endpoint - Success - {Unlock} — 202 — Accepted
{
"Response": {
"responseId": "292207828296005",
"responseTimestamp": "14/06/2020 04:40:17",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Modify Endpoint - Failure — 202 — Accepted
{
"Response": {
"responseId": "293928448584596",
"responseTimestamp": "14/06/2020 05:08:58",
"resultCode": "1",
"resultParam": {
"resultCode": "10069",
"resultDescription": "Modify endpoint failure - Endpoint already locked to an IMEI, Please UNLOCK the Endpoint first"
}
}
}Modify Endpoint - Success - {Lock} — 202 — Accepted
{
"Response": {
"responseId": "293896002082447",
"responseTimestamp": "14/06/2020 05:08:25",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - {Addons} — 200 — OK
{
"Response": {
"responseId": "293896002082447",
"responseTimestamp": "14/06/2020 05:08:25",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - Success {Lock with imei}
{
"Response": {
"responseId": "3015309429144666",
"responseTimestamp": "30/12/2020 10:02:09",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - Success {Unlock with imei}
{
"Response": {
"responseId": "3015309429144666",
"responseTimestamp": "30/12/2020 10:02:09",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - success {addValueAddedFeatureIds}
{
"Response": {
"responseId": "13549527215301469",
"responseTimestamp": "05/08/2021 11:14:52",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - success {removeValueAddedFeatureIds}
{
"Response": {
"responseId": "13549527215301469",
"responseTimestamp": "05/08/2021 11:14:52",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - success {addDynamicBenefitsIds}
{
"Response": {
"responseId": "19882100775620353",
"responseTimestamp": "17/10/2021 18:17:46",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - success {removeDynamicBenefitsIds}
{
"Response": {
"responseId": "19882100775620353",
"responseTimestamp": "17/10/2021 18:17:46",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - success {add or remove Tags}
{
"Response": {
"responseId": "19882100775620353",
"responseTimestamp": "17/10/2021 18:17:46",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - Failure {Subscriber not in active state}
{
"Response": {
"responseId": "8278738034557952",
"responseTimestamp": "19/09/2022 02:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "2503",
"resultDescription": "Subscriber not in active state"
}
}
}Endpoint - Modify - Success - removeAddonUniqueIds
{
"Response": {
"responseId": "17871651255422464",
"responseTimestamp": "22/12/2022 16:50:48",
"resultCode": "0",
"resultParam": {
"resultCode": "10199",
"resultDescription": "Your request is under process"
}
}
}Endpoint - Modify - Success - removeAddonPlanIds
{
"Response": {
"responseId": "8732880980362027",
"responseTimestamp": "19/01/2023 12:11:51",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - Success - Modify Endpoint name
{
"Response": {
"responseId": "1636712233179729",
"responseTimestamp": "24/04/2023 14:46:56",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - Success - Service barring
{
"Response": {
"responseId": "1636712233179729",
"responseTimestamp": "24/04/2023 14:46:56",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Modify - Failure -Modify Enpoint name
{
"Response": {
"responseId": "1636844050669500",
"responseTimestamp": "24/04/2023 14:49:08",
"resultCode": "1",
"resultParam": {
"resultCode": "1001",
"resultDescription": "Wrong input parameter - endPointName"
}
}
}Endpoint - Modify- Success-{APN}
{
"Response": {
"responseId": "11730805430592959",
"responseTimestamp": "05/11/2024 12:17:11",
"resultCode": "0",
"resultParam": {
"resultCode": "10068",
"resultDescription": "Modify endpoint success"
}
}
}Endpoint - Delete
Path: Endpoint / Endpoint - Delete
Method: POST
URL: https://sft.bics.com/api/DeleteEndPoint
Description
This API is used to Delete an Endpoint.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | EndPointID of the endpoint to delete. |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Object of response details |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10158 | Delete Endpoint is not allowed. Please De-Link SIM first. | |
10159 | Endpoint successfully deleted. | |
1001 | Wrong Input Parameter – {Parameter Name} | |
10160 | Internal failure |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51175551"
}
}Response Examples
Endpoint - Delete - Success — 200 — OK
{
"Response": {
"responseId": "292207828296005",
"responseTimestamp": "14/06/2020 04:40:17",
"resultCode": "0",
"resultParam": {
"resultCode": "10159",
"resultDescription": "Endpoint successfully deleted."
}
}
}Endpoint - Delete - Failure
{
"Response": {
"responseId": "292207828296005",
"responseTimestamp": "14/06/2020 04:40:17",
"resultCode": "0",
"resultParam": {
"resultCode": "10160",
"resultDescription": "Delete endpoint failure."
}
}
}Endpoint - Delete - Delete Endpoint is not allowed. Please De-Link SIM first
{
"Response": {
"responseId": "6725314016255857",
"responseTimestamp": "01/09/2022 07:00:36",
"resultCode": "1",
"resultParam": {
"resultCode": "10158",
"resultDescription": "Delete Endpoint is not allowed. Please De-Link SIM first"
}
}
}Endpoint - Get ICCID
Path: Endpoint / Endpoint - Get ICCID
Method: GET
URL: https://sft.bics.com/api/fetchICCIDForProvisioning
Description
This API is used to retrieve ICCIDs in Ready to Activate status. Only ranges eligible for Provisioning will come in response.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
responseParam | O | Object of ICCID info |
Output ResultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output ICCID list info Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
accountName | O | Name of account to whom SIM has been assigned to |
quantity | O | Total available quantity for SIM provisioning |
iccidRange | O | Range of the ICCID |
simStatus | O | Current status of SIM |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10048 | Fetch ICCID for provisioning success | |
10049 | Fetch ICCID for provisioning failure |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Response Examples
Endpoint Get ICCID - Failure — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10049",
"resultDescription": "Fetch ICCID for provisioning failure"
},
"resultCode": "1",
"responseId": "1589307147698",
"responseTimestamp": "12/05/2020 18:12:27"
}
}Endpoint Get ICCID - Failure - {Insufficient Privilege} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10002",
"resultDescription": "Insufficient privilege"
},
"resultCode": "1",
"responseId": "46584464113879662",
"responseTimestamp": "12/05/2020 10:12:00"
}
}Endpoint Get ICCID - Get ICCID - Success — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10048",
"resultDescription": "Fetch ICCID for provisioning success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"accountName": "Technologies",
"quantity": "2",
"iccidRange": "8932042000000010296-8932042000000010297",
"simStatus": "Ready To Activate"
}
]
},
"responseId": "43883829015917794",
"responseTimestamp": "12/05/2020 10:53:23"
}
}Endpoint - Bulk Create
Path: Endpoint / Endpoint - Bulk Create
Method: POST
URL: https://sft.bics.com/api/bulkProvisioning
Description
This API is used for bulk provisioning of Endpoints. This API is used to add new subscribers in bulk to the System, all of them with the same PDP profile,plan, roaming profile,dynamic benefit and credit limit(for post paid plan) If an error is detected while processing, the whole bulk will be rolled-back and treated as unsuccessful. The maximum allowed bulk size is 4000 subscribers. You can verify if the request was successful by calling “Get Bulk SIM Provisioning Detail” API.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
bulkProvisioningInfo | M | Object of the Bulk Provisioning info |
Input bulkProvisioningInfo Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
endPointName | M | EndPoint name static string |
endPointNameId | M | Endpoint name id, the actual endpoint names will be in a format like this "endPointName_endPointNameId" to endPointNameId + quantity - 1 |
apnGroupId | M | Apn Group Id, You can fetch the list of possible apnGroupId using "fetchApnGroup" API. |
planId | M | Plan id, You can fetch the list of possible planId using "QueryRatePlan" API. |
roamingProfileId | M | Array of roaming profile ids |
dynamicBenefitEnable | O | This parameter has become deprecated. It will be ignored by the system if sent. Subscription of an Endpoint to Dynamic Benefits is only mandatory if “dynamicBenefitEnable” is true on account level and only when the Endpoint is activated. |
benefits | CM | Pooled or non-pooled Dynamic Benefit ID, mandatory if "dynamicBenefitEnable" on account level is true and if the Endpoint is activated, optional otherwise. You can fetch the list of possible benefitIds using the "GetCustomerProfile" API. |
creditLimit | O | If creditLimit is not defined for Postpaid endpoint it will be created with creditLimit = Unlimited |
startICCID | CM | Start ICCID |
endICCID | CM | End ICCID range, end ICCID for provisioning would be calculated based on provided startICCID and quantity |
iccidList | CM | List of the target ICCIDs used for the endpoint creation.This field should contain a list of elements with 19 digits, only numbers. The list should not contain more than 4k ICCIDs |
quantity | CM | Quantity mandatory parameter only for cases when ICCIDs are defined as range (startICCID, endICCID). If ICCIDs are defined as iccidList Quantity parameter is not required |
imeiLockStatus | O | Imeilock status for an endpoint values: <br>LOCK <br>UNLOCK |
addonPlanIds | O | Plan id of addon plans which needs to be activated, You can fetch the list of possible planId using "QueryRatePlan" API. |
isDefaultActivation | O | Parameter which defines to activate SIM immediately/later <br>isDefaultActivation = true (Activate Immediately) <br>isDefaultActivation = false (To Create Endpoints in Pre-Active state) <br>Note: "isDefaultActivation" will be considered as true by default if this parameter is not specified in the request <br>Note: For OEM enabled accounts if isDefaultActivation = true (Activate Immediately) then the endpoint will be Active-Test(AT) state and for isDefaultActivation = false the endpoint will be in Pre-Active state |
valueAddedFeatureIds | O | IDs of value added features which need to be activated for the endpoint <br>Format should be like ["valueAddedFeatureId1","valueAddedFeatureId2"] <br>The exact values of the IDs can be retrieved from the value added features configured in the platform |
tagIds | O | List of TAG IDs (comma separated and within double quote) to be assigned to endpoint. |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
simProvisionId | O | SIM provisioning id - used to obtain the Bulk Endpoint Create job result |
Output ResultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10054 | Success!! request has sent for processing | |
10146 | Failure!! duplicate iccidList exist in the request | |
10148 | Failure!! Either use iccidList or range | |
10073 | Maximum count exceeds for input parameter - {reason} |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"bulkProvisioningInfo": {
"endPointName": "endpointBulk",
"endPointNameId": "1",
"apnGroupId": "PDP_1968",
"planId": "DEFAULTPRE41166994",
"roamingProfileId": ["125"],
"dynamicBenefitEnable": "true",
"benefits": "1568",
"startICCID": "8932042000000000011",
"endICCID": "8932042000000000011",
"quantity": "1",
"tagIds":["1001","1002","1003"]
}
}Response Examples
Endpoint Bulk Create - Success - {Normal Case} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10054",
"resultDescription": "Success !! request has sent for processing"
},
"resultCode": "0",
"responseId": "1589278484971",
"responseTimestamp": "12/05/2020 10:14:44",
"simProvisionId": "10471"
}
}Endpoint Bulk Create - Success - {With Dynamic Benefit} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10054",
"resultDescription": "Success !! request has sent for processing"
},
"resultCode": "0",
"responseId": "1589279651772",
"responseTimestamp": "12/05/2020 10:34:11",
"simProvisionId": "10476"
}
}Endpoint Bulk Create - Success - {With IccidList} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10054",
"resultDescription": "Success !! request has sent for processing"
},
"resultCode": "0",
"responseId": "6053655079046067",
"responseTimestamp": "24/08/2022 08:54:56",
"simProvisionId": "16581"
}
}Endpoint Bulk Create - Success
{
"Response": {
"resultParam": {
"resultCode": "10054",
"resultDescription": "Success !! request has sent for processing"
},
"resultCode": "0",
"responseId": "1589278484971",
"responseTimestamp": "12/05/2020 10:14:44",
"simProvisionId": "10782"
}
}Endpoint Bulk Create - Failure{ Either use iccidList or range}
{
"Response": {
"resultParam": {
"resultCode": "10145",
"resultDescription": "Failure!! Either use iccidList or range"
},
"resultCode": "0",
"responseId": "6053970069274466",
"responseTimestamp": "24/08/2022 09:00:11"
}
}Endpoint Bulk Create - Failure-{duplicate iccidList exist in the request }
{
"Response": {
"resultParam": {
"resultCode": "10146",
"resultDescription": "Failure!! duplicate iccidList exist in the request"
},
"resultCode": "0",
"responseId": "6054057593090033",
"responseTimestamp": "24/08/2022 09:01:38"
}
}Endpoint - Bulk Create - Process Status
Path: Endpoint / Endpoint - Bulk Create - Process Status
Method: GET
URL: https://sft.bics.com/api/fetchSIMProvisioningDetails
Description
Main purpose of this API is to verify that Bulk SIM provisioning was successful or not.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Query Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
simProvisionId | O | SIM provision id, You can fetch simProvisionId from the response of "bulkProvisioning" API. |
endpointStatus | O | endpointStatus category. <br>endpointStatus possible values <br>1.Active <br>2.Pre-Active <br>Note: This query parameter does not work with the combination of "simProvisionId" |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
responseParam | O | Response SIM Provisioning info parameters |
Output ResultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output Response Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
iccidRange | O | Iccid range which was used for bulk provisioning |
quantity | O | Quantity for bulk provisioning |
accountId | O | Account id who has performed bulk provisioning |
accountName | O | Account Name who has performed bulk provisioning |
simProvisionId | O | Bulk SIM provisioning id |
simProvisioningDate | O | Bulk SIM provisioning date <br>Format: dd/mm/yyyy hh:mm:ss |
status | O | Bulk SIM provisioning status it can be Processing, Success or Fail |
reason | O | Bulk SIM provisioning reason, If it is failed, then in reason failed details would be there |
endpointStatus | O | This parameter defines the status of the endpoint <br>Pre-Active - Status of the endpoints when the sims are just linked but not activated <br>Active - Status of the endpoints which are activated |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10050 | Fetch SIM provisioning details success | |
10051 | Fetch SIM provisioning details failure |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Response Examples
Endpoint Bulk Create - Process Status - Failure
{
"Response": {
"resultParam": {
"resultCode": "10051",
"resultDescription": "Fetch SIM provisioning details failure"
},
"resultCode": "1",
"responseId": "1589307147698",
"responseTimestamp": "12/05/2020 18:12:27"
}
}Endpoint Bulk Create - Process Status - Success - {All}
{
"Response": {
"resultParam": {
"resultCode": "10050",
"resultDescription": "Fetch SIM provisioning details success"
},
"resultCode": "0",
"responseId": "171249347740500",
"responseTimestamp": "12/05/2020 10:20:44",
"responseParam": {
"rows": [
{
"iccidRange": "9990000000000011466-9990000000000011469",
"endpointStatus": "Pre-Active",
"quantity": 3,
"accountId": "41166994",
"accountName": "mvneenterprise",
"simProvisionId": "10476",
"simProvisioningDate": "12/05/2020 10:14:44",
"status": "Success",
"reason": "Sim provisioning successful"
},
{
"iccidRange": "9990000000000011469-9990000000000011470",
"endpointStatus": "Active",
"quantity": 1,
"accountId": "41166994",
"accountName": "mvneenterprise",
"simProvisionId": "10477",
"simProvisioningDate": "12/05/2020 10:17:44",
"status": "Success",
"reason": "Sim provisioning successful"
}
]
}
}
}Endpoint Bulk Create - Process Status - Success - {Specific}
{
"Response": {
"resultParam": {
"resultCode": "10050",
"resultDescription": "Fetch SIM provisioning details success"
},
"resultCode": "0",
"responseId": "171249347740500",
"responseTimestamp": "12/05/2020 10:15:44",
"responseParam": {
"rows": [
{
"iccidRange": "9990000000000011466-9990000000000011469",
"endpointStatus": "Pre-Active",
"quantity": "102",
"accountId": "41166994",
"accountName": "mvneenterprise",
"simProvisionId": "10476",
"simProvisioningDate": "12/05/2020 10:14:44",
"status": "Success",
"reason": "Sim provisioning successful"
}
]
}
}
}Endpoint Bulk Create - Process Status - Failure {Attaching addons for Pre-Active endpoints}
{
"Response": {
"resultParam": {
"resultCode": "10050",
"resultDescription": "Fetch SIM provisioning details success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"iccidRange": "9990000000000014303-9990000000000014303",
"endpointStatus": "Pre-Active",
"quantity": 1,
"accountId": "41598666",
"accountName": "bulk_PROV_OEM",
"simProvisionId": "14334",
"simProvisioningDate": "08/02/2021 13:11:42",
"status": "Fail",
"reason": "Addon can only be assigned to Active endpoints"
}
]
},
"responseId": "11205750771069077",
"responseTimestamp": "08/02/2021 13:10:06"
}
}Endpoint Bulk Create - Process Status - Failure {ICCID is not valid, either ICCID does not exist on System or it is not in Ready-To-Active}
{
"Response": {
"resultParam": {
"resultCode": "10050",
"resultDescription": "Fetch SIM provisioning details success"
},
"resultCode": "0",
"responseParam": {
"rows": [
{
"iccidRange": "8932042000000000010-8932042000000000010",
"endpointStatus": "Active",
"quantity": 1,
"accountId": "41709975",
"accountName": "ent_1334",
"simProvisionId": "16587",
"simProvisioningDate": "24/08/2022 08:57:56",
"status": "Fail",
"reason": "ICCID is not valid, either ICCID does not exist on System or it is not in Ready-To-Active"
}
]
},
"responseId": "6053846472749663",
"responseTimestamp": "24/08/2022 08:58:07"
}
}Endpoint - Bulk Modify
Path: Endpoint / Endpoint - Bulk Modify
Method: PATCH
URL: https://sft.bics.com/api/endpointbulk
Description
This API is used for bulk Modification of Endpoints. The maximum allowed number is 4000 subscribers. You can verify the status of your request by calling “GET Job Status” API (under Organisation) using the Job ID provided in the responce.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resourceType | M | One of the below Resource Type needs to be used: <br>endPointid <br>imsi <br>msisdn <br>iccid |
valuelist | M | Value of the field to be updated based on the resource type used in request |
requestParam | M | Object of End Point details |
Input requestParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
imeiLockStatus | O | Imeilock status for an endpoint values: <br>LOCK <br>UNLOCK |
addAddonPlanIds | O | List of Addon plan IDs to be added. List is limited to maximum 10 addons IDs per API Call. <br>Note that the maximum number of addons that can be subscribed at any given time to an endpoint is 15. <br>You can fetch the list of possible planId using "QueryRatePlan" API. <br>NOTE:For OEM enabled accounts addition of Addon is restricted when the endpoint is in Active-Test or Active-Inventory state. |
removeValueAddedFeatureIds | O | IDs of value added features which need to be removed for the endpoint <br>Format should be like ["valueAddedFeatureId1","valueAddedFeatureId2"] <br>The exact values of the IDs can be retrieved from the value added features configured in the platform |
addValueAddedFeatureIds | O | IDs of value added features which need to be activated for the endpoint <br>Format should be like ["valueAddedFeatureId1","valueAddedFeatureId2"] <br>The exact values of the IDs can be retrieved from the value added features configured in the platform |
addDynamicBenefitsIds | O | List of pooled or non-pooled Dynamic Benefits IDs to subscribe the Endpoints to. Currently an Endpoint can be subscribed only to one pooled or non-pooled Dynamic Benefits. <br>You can fetch the list of IDs of available Dynamic Benefits IDs using the "GetCustomerProfile" API. |
removeDynamicBenefitsIds | O | List of pooled or non-pooled Dynamic Benefits IDs to unsubscribe the Endpoints from. A subscription to pooled or non-pooled Dynamic Benefits is mandatory if “dynamicBenefitEnable” is true on account level and if the Endpoint is activated. <br>You can fetch the ID of the currently subscribed Dynamic Benefits using the "GetEndpointProfile" API. |
addtagIds | O | List of TAG IDs (comma separated and within double quote) to be added to endpoint. |
removetagIds | O | List of TAG IDs (comma separated and within double quote) to be removed from endpoint. |
endPointName | O | New endpoint Name <br>can have <br>minimum of 5 characters, maximum of 30 characters, it can be alphanumeric, it can have space, colon and underscore. |
bar_2G | O | True <br>False <br>bar/unbar 2G |
bar_2G/3G | O | True <br>False <br>bar/unbar 2G/3G |
bar_4G | O | True <br>False <br>bar/unbar 4G |
bar_5G | O | True <br>False <br>bar/unbar 5G |
bar_SMS_MT | O | True <br>False <br>bar/unbar SMS_MT |
bar_SMS_MO | O | True <br>False <br>bar/unbar SMS_MO |
bar_DATA | O | True <br>False <br>bar/unbar DATA |
bar_NB_IOT | O | True <br>False <br>bar/unbar NB_IOT |
bar_All_Services | O | True <br>False <br>(1. if "bar_All_Services" is present rest all the barred parameters should be skipped. <br> <br>2. "bar_All_Services" will bar only services belongs to their Service Profile. If the Service Profile includes all the 4 services all the 4 below services will be barred) |
apnGroupId | O | APN Group ID, You can fetch the list of possible apnGroupId using "fetchApnGroup" API |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | API result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
JobId | O | Unique ID generated for each bulk modification, used to check the status of the transaction |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10070 | Success!! request has sent for processing | |
10073 | Maximum count exceeds for input parameter - {reason} | |
10134 | Modify endpoint(s) failure - {reason} |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request": {
"resourceType": "msisdn",
"valuelist": ["329999800011461"],
"requestParam": {
"imeiLockStatus": "LOCK"
}
}
}Response Examples
Endpoint - Bulk Modify - Success — 202 — Accepted
{
"Response": {
"responseId": "298017118206010",
"responseTimestamp": "14/06/2020 06:17:06",
"resultCode": "0",
"resultParam": {
"resultCode": "10070",
"resultDescription": "Success!! Request has sent for processing"
},
"JobId": "1032"
}
}Endpoint - Bulk Modify - Success -Modify Endpoint Name — 202 — Accepted
{
"Response": {
"responseId": "1636820353261697",
"responseTimestamp": "24/04/2023 14:48:44",
"resultCode": "0",
"resultParam": {
"resultCode": "10070",
"resultDescription": "Success!! request has sent for processing"
},
"JobId": "5586"
}
}Endpoint - Bulk Modify - Failure - {Maximum count exceeds for input Parameter} — 202 — Accepted
{
"Response": {
"responseId": "2399097810020486",
"responseTimestamp": "18/06/2020 05:55:35",
"resultCode": "1",
"resultParam": {
"resultCode": "10073",
"resultDescription": "Maximum count exceeds for input parameter - valueList"
}
}
}Endpoint - Bulk Modify - Failure- Modify Endpoint name — 202 — Accepted
{
"Response": {
"responseId": "1637533449938986",
"responseTimestamp": "24/04/2023 15:00:37",
"resultCode": "1",
"resultParam": {
"resultCode": "1001",
"resultDescription": "Wrong input parameter - endPointName"
}
}
}Endpoint - Bulk Modify - success {add and removeDynamicBenefitsIds}
{
"Response": {
"responseId": "20792567672468293",
"responseTimestamp": "28/10/2021 07:12:14",
"resultCode": "0",
"resultParam": {
"resultCode": "10070",
"resultDescription": "Success!! request has sent for processing"
},
"JobId": "1216"
}
}Endpoint - Bulk Modify - success {Service barring}
{
"Response": {
"responseId": "20792567672468293",
"responseTimestamp": "28/10/2021 07:12:14",
"resultCode": "0",
"resultParam": {
"resultCode": "10070",
"resultDescription": "Success!! request has sent for processing"
},
"JobId": "1218"
}
}Endpoint - Bulk Modify-Success-{APN}
{
"Response": {
"responseId": "01730805469490609",
"responseTimestamp": "05/11/2024 12:17:49",
"resultCode": "0",
"resultParam": {
"resultCode": "10070",
"resultDescription": "Success!! Request has sent for processing"
},
"JobId": "12072"
}
}Endpoint - Link SIM
Path: Endpoint / Endpoint - Link SIM
Method: POST
URL: https://sft.bics.com/api/LinkSim
Description
This API is used to link the SIM to the Endpoint. The Endpoint can be in Pre-Active or Hold state while attaching the SIM to the Endpoint. Endpoint will result in Pre-Active state after the SIM link also.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | Unique ID of the End Point |
requestParam | M | Object of End point details |
Input requestParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
iccid | M | ICCID associated with the SIM |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
6409 | Link SIM success | |
6410 | Link SIM failure | |
2507 | SIM already in active state | |
10108 | SIM already in suspend state | |
10109 | SIM already in preActive state | |
5016 | SIM already provisioned | |
10239 | Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not. | |
10240 | Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not. |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51079021",
"requestParam":{
"iccid":"8932042000000010296"
}
}
}Response Examples
Endpoint - Link SIM - Failure - {SIM Already In Active State} — 200 — OK
{
"Response": {
"responseId": "39210776587881608",
"responseTimestamp": "12/05/2020 03:13:46",
"resultCode": "1",
"resultParam": {
"resultCode": "2507",
"resultDescription": "SIM already in active state"
}
}
}Endpoint - Link SIM - Failure - {SIM already in preActive state} — 200 — OK
{
"Response": {
"responseId": "7157579691422257",
"responseTimestamp": "06/09/2022 05:35:51",
"resultCode": "1",
"resultParam": {
"resultCode": "10109",
"resultDescription": "SIM already in preActive state"
}
}
}Endpoint - Link SIM - Failure - {SIM already in suspend state} — 200 — OK
{
"Response": {
"responseId": "7157975897282693",
"responseTimestamp": "06/09/2022 05:42:27",
"resultCode": "1",
"resultParam": {
"resultCode": "10108",
"resultDescription": "SIM already in suspend state"
}
}
}Endpoint - Link SIM - Success — 200 — OK
{
"Response": {
"responseId": "37773667274039356",
"responseTimestamp": "31/01/2020 11:45:25",
"resultCode": "0",
"resultParam": {
"resultCode": "6409",
"resultDescription": "Link SIM success"
}
}
}Endpoint - Link SIM - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "6410",
"resultDescription": "Link SIM failure"
}
}
}Endpoint - De-Link SIM
Path: Endpoint / Endpoint - De-Link SIM
Method: POST
URL: https://sft.bics.com/api/DeLinkSim
Description
This API is used to De link the SIM with the Endpoint. Once the SIM is De linked from the Endpoint the status will be changed to hold. Plan, tariff, benefit, charges will be still attached to the endpoint, but the SIM will get removed and service will not be available.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | End Point Id |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
6413 | SIM delink success | |
6414 | SIM delink failure | |
6420 | SIM not attached | |
7021 | Successful!! request has sent for processing!! | If Sim is active and on going session |
10250 | Endpoint with RSP State = Local cannot be de-linked |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51079185"
}
}Response Examples
Endpoint - De-Link SIM - Failure - {SIM Not attached} — 200 — OK
{
"Response": {
"responseId": "39210717378805444",
"responseTimestamp": "12/05/2020 03:12:47",
"resultCode": "1",
"resultParam": {
"resultCode": "6420",
"resultDescription": "SIM not attached"
}
}
}Endpoint - De-Link SIM - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "6414",
"resultDescription": "SIM delink failure"
}
}
}Endpoint - De-Link SIM - Success — 200 — OK
{
"Response": {
"responseId": "39157571246968514",
"responseTimestamp": "12/05/2020 12:27:01",
"resultCode": "0",
"resultParam": {
"resultCode": "6413",
"resultDescription": "SIM delink success"
}
}
}Endpoint - De-Link SIM - Success - {Active On going session} — 200 — OK
{
"Response": {
"responseId": "39158149812995034",
"responseTimestamp": "12/05/2020 12:36:39",
"resultCode": "0",
"resultParam": {
"resultCode": "7021",
"resultDescription": "Successful!! request has sent for processing!!"
}
}
}Endpoint - Activate
Path: Endpoint / Endpoint - Activate
Method: POST
URL: https://sft.bics.com/api/EndPointActivation
Description
This API is used to activate the Endpoints.
For non-OEM enabled accounts, Pre-Activated Endpoints will be Active after the activation.
For OEM enabled accounts, Pre-Activated Endpoints will be Active-Test after the activation.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | End Point Id |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
5014 | SIM provisioning success | |
5015 | SIM provisioning failure | |
2507 | SIM already in active state | |
6420 | SIM not attached |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51075798"
}
}Response Examples
EndPoint - Activate - Failure - {SIM Not attached} — 200 — OK
{
"Response": {
"responseId": "39210524236955196",
"responseTimestamp": "12/05/2020 09:39:34",
"resultCode": "1",
"resultParam": {
"resultCode": "6420",
"resultDescription": "SIM not attached"
}
}
}EndPoint - Activate - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "5015",
"resultDescription": "SIM provisioning failure"
}
}
}EndPoint - Activate - Failure - {SIM Already In Active State}
{
"Response": {
"responseId": "39210611351657599",
"responseTimestamp": "12/05/2020 09:41:01",
"resultCode": "1",
"resultParam": {
"resultCode": "2507",
"resultDescription": "SIM already in active state"
}
}
}EndPoint Activation - Success — 200 — OK
{
"Response": {
"responseId": "15137782938820725894",
"responseTimestamp": "31/01/2020 02:19:56",
"resultCode": "0",
"resultParam": {
"resultCode": "5014",
"resultDescription": "SIM provisioning success"
}
}
}Endpoint - Status Change (Activate / Suspend)
Path: Endpoint / Endpoint - Status Change (Activate / Suspend)
Method: POST
URL: https://sft.bics.com/api/EndPointLifeCycleChange
Description
Endpoint LifeCycle Change API is used to change the Lifecycle of Endpoint.
For non-OEM enabled accounts: Endpoint can be moved from Active to Suspend or from Suspend to Active.
For OEM enabled accounts: Endpoint can be moved from Active-Test to Active-Inventory, from Active-Inventory to Active, and from Active-Test to Active.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
msisdn | CM | MSISDN for which lifecycle change to be done, Mandatory if the endPointId/IMSI is not given |
imsi | CM | IMSI for which lifecycle change to be done, Mandatory if the endPointId/MSISDN is not given |
endPointId | CM | Endpoint id for which lifecycle change to be done, Mandatory if the IMSI/MSISDN is not given |
requestParam | M | Object of Lifecycle details |
Input requestParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
lifeCycle | M | New Life Cycle to be changed <br>A – Active <br>S – Suspend <br>AI - Active-Inventory |
reason | O | Reason Code for Status change <br>1 – System Initiated <br>2 - Dunning <br>3 – CSR Initiated |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 - Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
responseParam | O | Object of Response details |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output responseParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
currentStatus | O | Current endpoint Status |
previousStatus | O | Previous endpoint Status |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
5017 | Lifecycle change success <br>Note:1. For non-OEM enabled accounts <br>2. Endpoint Lifecycle change from Active to Suspend (Applies for OEM Accounts also) | |
5018 | Endpoint/Subscriber lifecycle change failed | |
1254 | You are currently in same lifecycle | |
8104 | Endpoint in preactive/hold state | |
1008 | Invalid life cycle | |
1009 | Life cycle change not allowed due to endpoint/subscriber is in deactivate state | |
1242 | Life cycle change not allowed because parent is not in active state | |
9003 | Lifecycle change success <br>Note: For OEM enabled accounts | |
10245 | Lifecycle change requested... <br>Note: For Localised Endpoint | |
10244 | Activation/Suspension ongoing – try again later <br>Note: Localised Endpoint | |
10246 | Failed to change endpoint state - try again <br>Note: Localised Endpoint |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51079185",
"requestParam":{
"lifeCycle":"S",
"reason":"1"
}
}
}Response Examples
Endpoint - Status Change - Success - {Suspend to Active} — 200 — OK
{
"Response": {
"responseId": "1639159141959343251",
"responseTimestamp": "11/05/2020 07:23:12",
"resultCode": "0",
"resultParam": {
"resultCode": "5017",
"resultDescription": "Lifecycle change success"
},
"responseParam": {
"currentStatus": "A",
"previousStatus": "S"
}
}
}Endpoint - Status Change - Failure - {Same Lifecycle} — 200 — OK
{
"Response": {
"responseId": "1639159234985478911",
"responseTimestamp": "11/05/2020 07:24:45",
"resultCode": "1",
"resultParam": {
"resultCode": "1254",
"resultDescription": "You are currently in same lifecycle"
}
}
}Endpoint - Status Change - Success (Active-Test to Active-Inventory)
{
"Response": {
"responseId": "1639159210208032026",
"responseTimestamp": "11/05/2020 07:24:20",
"resultCode": "0",
"resultParam": {
"resultCode": "5017",
"resultDescription": "Lifecycle change success"
},
"responseParam": {
"currentStatus": "AI",
"previousStatus": "AT"
}
}
}Endpoint - Status Change - Failure - {PreActive/Hold State Endpoint used} — 200 — OK
{
"Response": {
"responseId": "1639210470202363399",
"responseTimestamp": "12/05/2020 09:38:40",
"resultCode": "1",
"resultParam": {
"resultCode": "8104",
"resultDescription": "Endpoint in preactive/hold state"
}
}
}Endpoint - Status Change - Success - {Active to Suspend} — 200 — OK
{
"Response": {
"responseId": "1639159210208032026",
"responseTimestamp": "11/05/2020 07:24:20",
"resultCode": "0",
"resultParam": {
"resultCode": "5017",
"resultDescription": "Lifecycle change success"
},
"responseParam": {
"currentStatus": "S",
"previousStatus": "A"
}
}
}Endpoint - Status Change - Success (Active-Test to Active)
{
"Response": {
"responseId": "1639159210208032026",
"responseTimestamp": "11/05/2020 07:24:20",
"resultCode": "0",
"resultParam": {
"resultCode": "5017",
"resultDescription": "Lifecycle change success"
},
"responseParam": {
"currentStatus": "A",
"previousStatus": "AT"
}
}
}Endpoint - Status Change - Success (Active-Inventory to Active )
{
"Response": {
"responseId": "1639159210208032026",
"responseTimestamp": "11/05/2020 07:24:20",
"resultCode": "0",
"resultParam": {
"resultCode": "5017",
"resultDescription": "Lifecycle change success"
},
"responseParam": {
"currentStatus": "A",
"previousStatus": "AI"
}
}
}Endpoint - Status Change - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "5018",
"resultDescription": "Endpoint/Subscriber lifecycle change failed"
}
}
}Endpoint - Status Change - Success (Localised Endpoint)
{
"Response": {
"responseId": "11750931761633130",
"responseTimestamp": "26/06/2025 11:56:02",
"resultCode": "0",
"resultParam": {
"resultCode": "10245",
"resultDescription": "Lifecycle change requested..."
},
"responseParam": {
"currentStatus": "A",
"previousStatus": "S"
}
}
}Endpoint - Status Change - Success (Localised Endpoint -Activation/Suspension ongoing)
{
"Response": {
"responseId": "01750930571191880",
"responseTimestamp": "26/06/2025 09:36:11",
"resultCode": "0",
"resultParam": {
"resultCode": "10244",
"resultDescription": "Activation/Suspension ongoing – try again later"
}
}
}Endpoint - Status Change - Success (Localised Endpoint -Failed to change endpoint state)
{
"Response": {
"responseId": "01750930571191880",
"responseTimestamp": "26/06/2025 09:36:11",
"resultCode": "0",
"resultParam": {
"resultCode": "10246",
"resultDescription": "Failed to change endpoint state - try again"
}
}
}Endpoint - Change Roaming Profile
Path: Endpoint / Endpoint - Change Roaming Profile
Method: POST
URL: https://sft.bics.com/api/ChangeEndpointRoamingProfile
Description
Change Endpoint Roaming Profile API is used to update the roaming profile of an Endpoint.
Only Base Plan Roaming profile change is allowed and it can be changed even if endpoint is in OEM states Active-Test and Active-Inventory.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
msisdn | CM | MSISDN for which we change the roaming profile <br>Mandatory if the end Point ID/IMSI is not given |
Imsi | CM | IMSI for which we change the roaming profile <br>Mandatory if end Point ID / MSISDN is not given |
endPointId | CM | Endpoint ID for which we change the roaming <br>Mandatory if IMSI/MSISDN is not given |
requestParam | M | Object of Roaming Profile details |
Input requestParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
roamingProfileIds | M | String array of Roaming Profiles, newly added Roaming profile will be overwritten with the existing roaming profiles. You can fetch the list of possible roamingProfileId using "GetRoamingProfiles" API. |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 - Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
1372 | Update roaming profile success | |
1373 | Update roaming profile failed | |
2503 | Subscriber not in active state |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"imsi":"206281000010297",
"requestParam":{
"roamingProfileIds":[
"2"
]
}
}
}Response Examples
Endpoint - Change Roaming Profile - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "1373",
"resultDescription": "Update roaming profile failed"
}
}
}Endpoint - Change Roaming Profile - Success - {IMSI} — 200 — OK
{
"Response": {
"responseId": "39160778536170907",
"responseTimestamp": "11/05/2020 07:50:28",
"resultCode": "0",
"resultParam": {
"resultCode": "1372",
"resultDescription": "Update roaming profile success"
}
}
}Endpoint - Change Roaming Profile - Success - {Endpoint Id} — 200 — OK
{
"Response": {
"responseId": "39160686698783569",
"responseTimestamp": "11/05/2020 07:48:56",
"resultCode": "0",
"resultParam": {
"resultCode": "1372",
"resultDescription": "Update roaming profile success"
}
}
}Endpoint - Change Roaming Profile - Success - {MSISDN} — 200 — OK
{
"Response": {
"responseId": "39160433772287854",
"responseTimestamp": "11/05/2020 07:44:43",
"resultCode": "0",
"resultParam": {
"resultCode": "1372",
"resultDescription": "Update roaming profile success"
}
}
}Endpoint - Change Roaming Profile - failure {Update Roaming profile which is not present in the base plan}
{
"Response": {
"responseId": "8357453658970871",
"responseTimestamp": "06/01/2021 13:58:18",
"resultCode": "1",
"resultParam": {
"resultCode": "1001",
"resultDescription": "Wrong input parameter - roamingProfileIds"
}
}
}Endpoint - Change Roaming Profile - failure {Passing TEST roamingProfileId in the request}
{
"Response": {
"responseId": "8361930830640929",
"responseTimestamp": "06/01/2021 15:12:51",
"resultCode": "1",
"resultParam": {
"resultCode": "1001",
"resultDescription": "Wrong input parameter - roamingProfileIds"
}
}
}Endpoint - Plan Change
Path: Endpoint / Endpoint - Plan Change
Method: POST
URL: https://sft.bics.com/api/ChangePlan
Description
Plan Change API is used to change the Base plan of the Endpoint.
Plan change is allowed at all states of the Endpoint except when it is De-active. It is not allowed if the Endpoint is at any of the OEM states (active-inventory, active-test).
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parametersupdate
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
msisdn | CM | MSISDN for which lifecycle change to be done, <br>Mandatory if the endPointId/IMSI is not given |
Imsi | CM | IMSI for which lifecycle change to be done, <br>Mandatory if the endPointId/IMSI is not given |
endPointId | CM | Endpoint id for which lifecycle change to be done, <br>Mandatory if the endPointId/IMSI is not given |
requestParam | M | Object of plan change details |
Input requestParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
planId | M | New Plan Reference Code, You can fetch the list of possible planId using "QueryRatePlan" API. |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time. <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
7001 | Plan change success | |
7002 | Plan change failure | |
7000 | PlanType not matching | |
5020 | Plan already exists |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request":{
"endPointId":"51079192",
"requestParam":{
"planId":"560082"
}
}
}Response Examples
Endpoint - Plan Change - Success - {Postpaid} — 200 — OK
{
"Response": {
"responseId": "1739216800924323550",
"responseTimestamp": "12/05/2020 04:54:11",
"resultCode": "0",
"resultParam": {
"resultCode": "7001",
"resultDescription": "Plan change success"
}
}
}Endpoint - Plan Change - Failure - {PlanType Not Matching} — 200 — OK
{
"Response": {
"responseId": "1739217406966592008",
"responseTimestamp": "12/05/2020 05:04:17",
"resultCode": "1",
"resultParam": {
"resultCode": "7000",
"resultDescription": "PlanType not matching"
}
}
}Endpoint - Plan Change - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "7002",
"resultDescription": "Plan change failure"
}
}
}Endpoint - Plan Change - Failure - {Plan Already Exists} — 200 — OK
{
"Response": {
"responseId": "1739217369679722415",
"responseTimestamp": "12/05/2020 05:03:39",
"resultCode": "1",
"resultParam": {
"resultCode": "5020",
"resultDescription": "Plan already exists"
}
}
}Endpoint - Plan Change - Failure{Baseplan Plan Change is not allowed for OEM Enabled}
{
"Response": {
"responseId": "2816707051321274",
"responseTimestamp": "21/02/2022 06:28:49",
"resultCode": "1",
"resultParam": {
"resultCode": "10173",
"resultDescription": "Baseplan Plan Change is not allowed for OEM Enabled"
}
}
}Endpoint - Threshold
Path: Endpoint / Endpoint - Threshold
Method: POST
URL: https://sft.bics.com/api/UpdateThreshold
Description
Update Threshold API is used to update the data threshold counter for the endpoint.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | End Point ID <br>NOTE: Updating the threshold value of ActiveTest and ActiveInventory endpoints are not supported |
requestParam | M | Object of threshold change details |
Input requestParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
threshold | M | Threshold to be updated (value should be in MB) |
planId | CM | PlanId of the counter whose threshold to be updated |
counterId | M | counterId whose threshold to be updated |
uniqueId | M | UniqueId of the Addon for which Counter to be updated. Can we retrieved via the GET PLAN api. |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
3005 | Update endpoint/customer success | |
3006 | Update endpoint/customer failure | |
6721 | No counter exists | |
10252 | Data threshold counter cannot be updated for endpoints with RSP State = Local |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Request Body
{
"Request": {
"endPointId": "51788643",
"requestParam": {
"planId": "619721",
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"uniqueId": "23770",
"threshold": "3"
}
}
}Response Examples
Endpoint - Threshold - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "3006",
"resultDescription": "Update endpoint/customer failure"
}
}
}Endpoint - Threshold - Failure - {No counter exists}
{
"Response": {
"responseId": "39160940586256997",
"responseTimestamp": "12/05/2020 01:23:10",
"resultCode": "1",
"resultParam": {
"resultCode": "6721",
"resultDescription": "No counter exists"
}
}
}Endpoint - Threshold - Success — 200 — OK
{
"Response":{
"responseId":"2012881626420895263",
"responseTimestamp":"12/05/2020 01:22:24",
"resultCode":"0",
"resultParam":{
"resultCode":"3005",
"resultDescription":"Update endpoint/customer success"
}
}
}Endpoint - Threshold - Success (counter addon plan}) — 200 — OK
{
"Response":{
"responseId":"2012881626420895263",
"responseTimestamp":"12/05/2020 01:22:24",
"resultCode":"0",
"resultParam":{
"resultCode":"3005",
"resultDescription":"Update endpoint/customer success"
}
}
}Endpoint - Statistics
Path: Endpoint / Endpoint - Statistics
Method: GET
URL: https://sft.bics.com/api/GetStatistics?endPointId=51079021&from_date=20200101&to_date=20200225
Description
Get Statistics per Endpoint API is used to get data, SMS usage reports for given period.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Query Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | End Point Id |
from_date | M | From Date (YYYYMMDD) |
to_date | M | To Date (YYYYMMDD) |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
responseParam | O | List of usage details |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output responseParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
smsUsage | O | List of SMS Usage Details |
dataUsage | O | List of Data Usage Details |
nbiotUsage | O | List of NB-IoT Usage Details |
smsTotalUsage | O | SMS Total Usage in the chosen time frame |
dataTotalUsage | O | Data Total Usage in the chosen time frame |
nbiotTotalUsage | O | NB-IoT Total Usage in the chosen time frame |
Output smsUsage Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
totalCost | O | Total Cost of Usage |
totalCount | O | Total Count of Usage |
serviceName | O | Service Name |
date | O | date of usage Format dd/mm/yyyy |
Output dataUsage Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
uplink | O | Uplink Usage (MB).The response shall be with 3 decimals. |
downlink | O | Downlink Usage (MB).The response shall be with 3 decimals. |
totalVolume | O | Total volume Usage (MB).The response shall be with 3 decimals. |
totalCost | O | Total Cost of Usage.The response shall be with 3 decimals. |
date | O | date of usage Format dd/mm/yyyy |
Output nbiotUsage Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
uplink | O | Uplink Usage (MB).The response shall be with 3 decimals. |
downlink | O | Downlink Usage (MB).The response shall be with 3 decimals. |
totalVolume | O | Total volume Usage (MB).The response shall be with 3 decimals. |
totalCost | O | Total Cost of Usage.The response shall be with 3 decimals. |
date | O | date of usage Format dd/mm/yyyy |
OUTPUT SMSTOTALUSAGE PARAMETERS
Field | Optional/Mandatory | Description |
|---|---|---|
totalCost | O | Total Cost of Usage |
totalCount | O | Total Count of Usage |
serviceName | O | Service Name |
OUTPUT DATATOTALUSAGE PARAMETERS
Field | Optional/Mandatory | Description |
|---|---|---|
uplink | O | Uplink Usage (MB).The response shall be with 3 decimals. |
downlink | O | Downlink Usage (MB).The response shall be with 3 decimals. |
totalVolume | O | Total volume Usage (MB).The response shall be with 3 decimals. |
totalCost | O | Total Cost of Usage.The response shall be with 3 decimals. |
OUTPUT NBIOTTOTALUSAGE PARAMETERS
Field | Optional/Mandatory | Description |
|---|---|---|
uplink | O | Uplink Usage (MB).The response shall be with 3 decimals. |
downlink | O | Downlink Usage (MB).The response shall be with 3 decimals. |
totalVolume | O | Total volume Usage (MB).The response shall be with 3 decimals. |
totalCost | O | Total Cost of Usage.The response shall be with 3 decimals. |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
2589 | Get endpoint statistics success |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Query Parameters
Parameter | Value | Description |
|---|---|---|
|
| |
|
| |
|
|
Response Examples
Get Endpoint - Statistics - Failure - {No record Exists} — 200 — OK
{
"Response": {
"responseId": "39210377015752343",
"responseTimestamp": "12/05/2020 09:37:07",
"resultCode": "1",
"resultParam": {
"resultCode": "1340",
"resultDescription": "No record exists"
}
}
}Get Endpoint - Statistics - Success DATA with 3 digit decimal
{
"Response": {
"responseId": "8475468625058662",
"responseTimestamp": "11/11/2020 18:57:32",
"resultCode": "0",
"resultParam": {
"resultCode": "2589",
"resultDescription": "Get endpoint statistics success"
},
"responseParam": {
"dataUsage": [
{
"totalCost": "6.002",
"date": "09/11/2020",
"uplink": "1.182",
"downlink": "4.82",
"totalVolume": "6.002"
},
{
"totalCost": "159.031",
"date": "10/11/2020",
"uplink": "17.777",
"downlink": "141.254",
"totalVolume": "159.031"
}
],
"dataTotalUsage": {
"totalCost": "165.033",
"uplink": "18.959",
"downlink": "146.074",
"totalVolume": "165.033"
}
}
}
}Get Endpoint - Statistics - Success NB-IOT with 3 digit decimal
{
"Response": {
"responseId": "7516144963540360",
"responseTimestamp": "02/06/2022 09:15:09",
"resultCode": "0",
"resultParam": {
"resultCode": "2589",
"resultDescription": "Get endpoint statistics success"
},
"responseParam": {
"nbiotUsage": [
{
"totalCost": "3407.794",
"date": "02/06/2022",
"uplink": "2",
"downlink": "1",
"totalVolume": "4"
}
],
"nbiotTotalUsage": {
"totalCost": "3407.794",
"uplink": "2",
"downlink": "1",
"totalVolume": "4"
}
}
}
}Get Endpoint - Statistics - Success with DATA and SMS — 200 — OK
{
"Response": {
"responseId": "39155491213618238",
"responseTimestamp": "11/05/2020 06:22:21",
"resultCode": "0",
"resultParam": {
"resultCode": "2589",
"resultDescription": "Get endpoint statistics success"
},
"responseParam": {
"smsUsage": [
{
"totalCost": "3",
"serviceName": "SMS_MO",
"date": "26/04/2020",
"totalCount": "3"
},
{
"totalCost": "2",
"serviceName": "SMS_MO",
"date": "28/04/2020",
"totalCount": "2"
},
],
"dataUsage": [
{
"totalCost": "0.473",
"date": "27/04/2020",
"uplink": "2.02",
"downlink": "21.65",
"totalVolume": "23.67"
},
{
"totalCost": "0.237",
"date": "28/04/2020",
"uplink": "1.01",
"downlink": "10.82",
"totalVolume": "11.84"
}
],
"smsTotalUsage": [
{
"totalCost": "5",
"serviceName": "SMS_MO",
"totalCount": "5"
}
],
"dataTotalUsage": {
"totalCost": "0.710",
"uplink": "3.03",
"downlink": "32.47",
"totalVolume": "35.50"
}
}
}
}Endpoint - Profile
Path: Endpoint / Endpoint - Profile
Method: GET
URL: https://sft.bics.com/api/GetEndPointProfile?endPointId=51170448
Description
Get Endpoint Profile API is used to fetch the Endpoint details from the platform.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Query Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
endPointId | M | End Point ID |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | API result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
info | O | Object of end point Info details |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output info Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
basicInfo | O | Object of Basic Info |
benefitInfo | O | List of benefit Objects |
Counter | O | List of counter details |
PromotionalPlans | O | List of promotional plans |
Output basicInfo Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
msisdn | O | MSISDN of the endpoint / Local MSISDN of the endpoint when rspState=Local |
maBalance | O | Main Account Balance (Balance is in cents (multiplied by 100)) |
creationDate | O | Date of Creation |
currentStatus | O | Endpoint current status <br>A – Active <br>S – Suspend <br>H – Hold <br>PA – Pre-Active <br>AT - Active-Test (available only for OEM enabled accounts) <br>AI - Active-Inventory (available only for OEM enabled accounts) |
currentStatusName | O | Endpoint current status Name <br>Active <br>Suspend <br>Hold <br>Pre-Active <br>Active-Test (available only for OEM enabled accounts) <br>Active-Inventory (available only for OEM enabled accounts) |
ocExpiryDate | O | Endpoint Expiry Date, After oc Expiry Date system will move the Endpoint to the next lifecycle Format: dd/mm/yyyy hh:mm:ss |
planId | O | Base Plan ID |
planName | O | Base Plan Name |
subscriberType | O | Endpoint Type <br>0 - Prepaid <br>1 - Postpaid |
subscriberTypeName | O | Endpoint Type Name <br>Prepaid <br>Postpaid |
endPointId | O | EndPoint ID, Unique ID generated for each EndPoint |
creditLimit | O | Monthly Limit of the Postpaid endpoint |
parentEntityId | O | Parent Entity Id, Parent Customer ID |
nextBillingDate | O | Next Bill Cycle Date for the Postpaid Customer |
planEffectiveDate | O | Plan Effective Date <br>Format: dd/mm/yyyy hh:mm:ss |
planExpiryDate | O | Plan Expiry Date <br>Format: dd/mm/yyyy hh:mm:ss |
currencyId | O | Currency Id of the endpoint. We can fetch the timeZone Id from the API GetCurrency |
currencyType | O | Currency Type |
tierId | O | Tier or Hierarchy ID refers to the customer hierarchy <br>5 - Endpoint |
staticIP | O | Static IP assigned |
apn | O | Access Point Name |
roamingProfileId | O | Roaming Profile Ids attached to the endpoint. Here the roaming profile Ids are separated by ' |
roamingProfileName | O | Roaming Profile Name attached to the endpoint. Here the roaming profile names are separated by ' |
apnGroupId | O | APN Group Id |
blockService | O | Block Service Flag |
ratType | O | Service Profile Access Type(RAT Type) <br>01 – 2G/3G <br>02 – 2G <br>06 - 2G/3G/4G <br>10 - 2G/3G/4G/5G |
ratTypeName | O | RAT Type Name <br>2G/3G <br>2G <br>2G/3G/4G <br>2G/3G/4G/5G |
name | O | Endpoint Name |
currentActiveImsi | O | Current Active Imsi / Local IMSI of the endpoint when rspState=Local |
simStatus | O | Sim Status |
endpointStatus | O | Endpoint Status |
enterpriseAccountStatus | O | Indicates the enterprise account Status <br>Enabled - Active <br>Disabled - InActive |
enterpriseDataService | O | Indicate the corresponding Endpoint's Enterprise having DATA service or not |
enterpriseSMSService | O | Indicate the corresponding Endpoint's Enterprise having SMS service or not |
enterpriseNbiotService | O | Indicate the corresponding Endpoint's Enterprise having NB-IOT service or not |
readyForSms | O | Indicates the SMS service <br>Yes - SMS services are available <br>No - SMS services are not available |
dependendRatType | O | Dependend Rat Type |
imsi | O | IMSI of the Endpoint / Local IMSI of the endpoint when rspState=Local |
imei | O | IMEI of the used device |
pdpProfileName | O | Pdp Profile Name |
iccid | O | ICCID of the endpoint / Local ICCID of the endpoint when rspState=Local |
simType | O | Sim Type |
simManufacture | O | Sim Manufacture |
simApplet | O | Sim Applet |
timeZoneId | O | TimeZone Id of the endpoint. We can get the corresponding timeZone details from the API GetTimeZone |
timeZoneName | O | Time Zone Name |
customerExpiryDate | O | Customer Expiry Date |
benefits | O | Name of pooled or non-pooled Dynamic Benefits the Endpoint is subscribed to. |
benefitIds | O | ID of pooled or non-pooled Dynamic Benefits the Endpoint is subscribed to. |
framedIp | O | Framed IP of endpoint |
imeiLockStatus | O | Imei lock status – LOCK / UNLOCK |
testPlanName | O | Name of the Test plan (available only for OEM enabled accounts) |
testPlanId | O | ID of the Test plan (available only for OEM enabled accounts) |
inventoryPlanName | O | Name of the Inventory plan (available only for OEM enabled accounts) |
inventoryPlanId | O | ID of the Inventory plan (available only for OEM enabled accounts) |
testRoamingProfileName | O | Name of the Test Roaming profile (available only for OEM enabled accounts) |
testRoamingProfileId | O | ID of the Test Roaming profile (available only for OEM enabled accounts) |
blacklistedNetworks | O | Indicates that there are blacklisted networks for an endpoint <br>Yes = The network is blacklisted <br>No =The network is not blacklisted |
lastSimStateChangeDateTime | O | The timestamp (dateTime) of the last SIM state. |
eid | M | EID of the endpoint |
eSimProfileStatus | M | Indicates the step reached within the eSIM Profile Download and Installation procedure: <br>- installed <br>- downloaded <br>- enabled <br>- disabled <br>- deleted <br>- error . |
rspState | M | Indicates the SIM profile state <br>-Global <br>-Global (Local Downloaded) <br>-Global(Local SetFallback) <br>-Local |
OUTPUT PROMOTIONALPLANS PARAMETERS (ADDON PLAN)
Field | Optional/ Mandatory | Description |
|---|---|---|
plan | O | List of Add-on Plans Plans associated with the endpoint |
OUTPUT PLAN PARAMETERS (ADDON PLAN)
Field | Optional/ Mandatory | Description |
|---|---|---|
planId | O | Add-on Plan ID |
planName | O | Add-on Plan Name |
planServiceId | O | Add-on Plan Service ID |
planServiceName | O | Add-on Plan Service Name |
planStartDate | O | Add-on Plan Start Date Format:dd/mm/yyyy hh:mm:ss |
planExpiryDate | O | Add-on Plan Expiry Date Format:dd/mm/yyyy hh:mm:ss |
uniqueId | O | UniqueId of the Addon for which the Endpoint Subscribed |
Output benefitInfo Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
benefit | O | List of benefit associated with end point |
dynamicBenefitsDetails | O | List with details of non-pooled Dynamic Benefits the Endpoint is subscribed to. |
Output benefit Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
id | O | Benefit ID |
name | O | Benefit Name |
startDate | O | Start Date <br>Format: dd/mm/yyyy hh:mm:ss |
expiryDate | O | Expiry Date <br>Format: dd/mm/yyyy hh:mm:ss |
balance | O | Balance. The value depends on the "type" and the "unitType" of the benefit <br>For example <br>- If the "type": "Main Account", then the "balance" value can be UNLIMITED string or digits (in cents). <br>- If the "type": "ADDON-ACCOUNT (FREE)" & "unitType": "MB", then the "balance" value will be in bytes <br>- If the "type": "ADDON-ACCOUNT (FREE)" & "unitType": "COUNT", then the "balance" value will be in count. |
unitType | O | Unit Type. Possible Values: <br>- Count (for SMS) <br>- MB (for Data) |
type | O | Type of the Benefit. Possible Values: <br>- ADDON-ACCOUNT (MONEY) <br>- ADDON-ACCOUNT (FREE) <br>- Main Account |
actualBalance | O | Account Actual/Initial Balance |
planId | O | The ID of the Plan responsible for the specific Benefit |
planName | 0 | The NAME of the Plan responsible for the specific Benefit |
planCategory | 0 | The Category of the Plan responsible for the specific Benefi (Base or Addon) |
uniqueId | 0 | The Unique Id of the Plan for which the Endpoint Subscribed <br>NOTE : Uniqueid is available only after endpoint is Active |
Output counter Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
counterId | O | Counter Id |
counterName | O | Counter Name |
usage | O | Left over Usage in MB |
action | O | Action |
thresholdUnit | O | Threshold Unit |
frequency | O | Frequency |
factor | O | factor |
thresholdValue | O | Threshold Value |
resetDate | O | When the counter will be reset. Format: dd/mm/yyyy hh:mm:ss |
OUTPUT DYNAMICBENEFITSDETAILS PARAMETERS
Field | Optional/ Mandatory | Description |
|---|---|---|
dynamicBenefitsId | O | ID of the Dynamic Benefits. |
name | O | Name of the Dynamic Benefits. |
category | 0 | Category ID <br>2 – Non-Pooled |
autoRenewal | O | Flag indicating whether the Dynamic Benefits are auto-renewed (recurring) or one-time. <br>Recurring if set to true. |
activationTime | O | Timestamp of the activation <br>Format: dd/mm/yyyy hh:mm:ss |
expiryTime | O | Timestamp of the end of the current validity period (i.e. expiry or renewal) |
benefitList | O | Object of benefits details. |
priority | O | Priority of the Dynamic Benefits as integer (smallest value = highest priority) |
OUTPUT BENEFITLIST PARAMETERS
Field | Optional/ Mandatory | Description |
|---|---|---|
benefitId | O | ID of the benefit. |
benefit | O | Benefit type <br>1 – DATA |
ratezone | O | Ratezone ID. |
value | O | Amount of benefit given. Depending on the selection of the Benefit <br>DATA → “MB”. |
balance | O | Current available balance for non-pooled Dynamic Benefits in least unit (bytes) |
priority | O | Priority of the benefit as integer (smallest value = highest priority) |
OUTPUT TAGIDLIST PARAMETERS
Field | Optional/ Mandatory | Description |
|---|---|---|
tagName | O | Name of the tag |
tagId | O | Tagid |
tagDescription | O | Tag description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
1082 | Get endpoint profile success | |
1083 | Get endpoint profile failure |
Headers
Header | Value |
|---|---|
|
|
|
|
Query Parameters
Parameter | Value | Description |
|---|---|---|
|
|
Response Examples
EndPoint Profile - Failure
{
"Response": {
"responseId": "10147764526003929674",
"responseTimestamp": "26/05/2020 01:59:44",
"resultCode": "1",
"resultParam": {
"resultCode": "1083",
"resultDescription": "Get endpoint profile failure"
}
}
}Get EndPoint Profile - Success {Active-Test Endpoint}
{
"Response": {
"responseId": "22100819974024231",
"responseTimestamp": "12/11/2021 10:36:27",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "329999800037277",
"maBalance": "UNLIMITED",
"creationDate": "12/11/2021 11:35:01",
"currentStatus": "AT",
"currentStatusName": "Active-Test",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "DEFAULTPOST41652734",
"planName": "DEFAULT POSTPAID PLAN",
"imsi": "999980000037277",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "41657734",
"planEffectiveDate": "12/11/2021 11:35:01",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"apn": "sft1",
"roamingProfileId": "8953|8954",
"roamingProfileName": "DEFAULT|TEST",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "299",
"iccid": "9990000000000037277",
"ratType": "10",
"ratTypeName": "2G/3G/4G/5G",
"name": "Endpoint01",
"endPointId": "51664782",
"apnGroupId": "PDP_14575",
"currentActiveImsi": "999980000037277",
"simStatus": "Active-Test",
"endpointStatus": "Active-Test",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Active",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "BICS",
"readyForSms": "Yes",
"dependendRatType": "02|01|06|10",
"benefits": "EnterpriseOEM10 - pooled",
"benefitIds": "6261",
"imeiLockStatus": "UNLOCK",
"testPlanName": "TEST POSTPAID PLAN",
"testPlanId": "TESTPOST41652734",
"inventoryPlanName": "INVENTORY POSTPAID PLAN",
"inventoryPlanId": "INVENTORYPOST41652734",
"testRoamingProfileName": "TEST_ROAMING",
"testRoamingProfileId": "8954",
"blacklistedNetworks": "Yes"
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "12/11/2021 11:35:01",
"expiryDate": "03/12/2021 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
},
{
"id": "5",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "15728640",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "15728640",
"planId": "DEFAULTPOST41652734",
"planName": "DEFAULT POSTPAID PLAN",
"planCategory": "NORMAL"
},
{
"id": "5",
"name": "DATA",
"startDate": "12/11/2021 11:35:01",
"expiryDate": "-",
"balance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "10485760",
"planId": "TESTPOST41652734",
"planName": "TEST POSTPAID PLAN",
"planCategory": "TEST"
},
{
"id": "5",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "4194304",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "4194304",
"planId": "568677",
"planName": "new_addon_post",
"planCategory": "ADDON"
}
]
},
"tagIdList":[
{"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
},
{"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
}
]
}
}
}Get EndPoint Profile - Success {lastSimStateChangeDateTime}
{
"Response": {
"responseId": "14911051207105426",
"responseTimestamp": "18/11/2022 10:27:25",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "329999800034184",
"maBalance": "UNLIMITED",
"creationDate": "16/11/2022 06:27:19",
"currentStatus": "S",
"currentStatusName": "Suspend",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "DEFAULTPOST41674564",
"planName": "DEFAULT POSTPAID PLAN",
"imsi": "999980000034184",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "41674564",
"nextBillingDate": "01/12/2022 00:00:00",
"planEffectiveDate": "16/11/2022 06:27:19",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"apn": "sft1|sixdee_demo_apn",
"roamingProfileId": "20514",
"roamingProfileName": "DEFAULT",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "301",
"iccid": "9990000000000034184",
"ratType": "01",
"ratTypeName": "2G/3G",
"name": "aishwarya123",
"endPointId": "51772322",
"apnGroupId": "PDP_17794",
"currentActiveImsi": "999980000034184",
"simStatus": "Suspended",
"lastSimStateChangeDateTime": "16/11/2022 12:34:08",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Disabled",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "BICS",
"readyForSms": "No",
"dependendRatType": "02|01",
"imeiLockStatus": "UNLOCK",
"blacklistedNetworks": "No"
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "16/11/2022 06:27:19",
"expiryDate": "01/12/2022 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
}
]
}
}
}
}Get EndPoint Profile - Success {Active-Inventory Endpoint}
{
"Response": {
"responseId": "22101537886367076",
"responseTimestamp": "12/11/2021 10:48:24",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "329999800037123",
"maBalance": "UNLIMITED",
"creationDate": "12/11/2021 11:39:08",
"currentStatus": "AI",
"currentStatusName": "Active-Inventory",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "574505",
"planName": "Plan01",
"imsi": "999980000037123",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "41652734",
"planEffectiveDate": "12/11/2021 11:39:08",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"apn": "sft1",
"roamingProfileId": "8953",
"roamingProfileName": "DEFAULT",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "299",
"iccid": "9990000000000037123",
"ratType": "06",
"ratTypeName": "2G/3G/4G",
"name": "Endpoint02",
"endPointId": "51664783",
"apnGroupId": "PDP_14575",
"currentActiveImsi": "999980000037123",
"simStatus": "Active-Inventory",
"endpointStatus": "Active-Inventory",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Active",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "BICS",
"readyForSms": "Yes",
"dependendRatType": "02|01|06",
"benefits": "EnterpriseOEM10 - pooled",
"benefitIds": "6261",
"imeiLockStatus": "UNLOCK",
"inventoryPlanName": "INVENTORY POSTPAID PLAN",
"inventoryPlanId": "INVENTORYPOST41652734",
"blacklistedNetworks": "Yes"
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "12/11/2021 11:47:34",
"expiryDate": "14/11/2021 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
},
{
"id": "5",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "15728640",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "15728640",
"planId": "574505",
"planName": "Plan01",
"planCategory": "NORMAL"
},
{
"id": "5",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "4194304",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "4194304",
"planId": "568677",
"planName": "new_addon_post",
"planCategory": "ADDON"
}
]
},
"tagIdList":[
{"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
},
{"tagName": "Customer Tag Name A",
"tagId": "10001010",
"tagDescription": "This is my tag description"
}
]
}
}
}Get EndPoint Profile - Success {Nonpooled/pooled Endpoint}
{
"Response": {
"responseId": "19880544811824776",
"responseTimestamp": "17/10/2021 17:51:50",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "329999800029482",
"maBalance": "UNLIMITED",
"creationDate": "12/10/2021 06:29:02",
"currentStatus": "A",
"currentStatusName": "Active",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "DEFAULTPOST41661396",
"planName": "DEFAULT POSTPAID PLAN",
"imsi": "999980000029482",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "41661396",
"nextBillingDate": "01/11/2021 00:00:00",
"planEffectiveDate": "12/10/2021 06:29:02",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"apn": "sft1",
"roamingProfileId": "15088",
"roamingProfileName": "DEFAULT",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "301",
"iccid": "9990000000000029482",
"ratType": "10",
"ratTypeName": "2G/3G/4G/5G",
"name": "test_Nonpooled",
"endPointId": "51661404",
"apnGroupId": "PDP_15317",
"currentActiveImsi": "999980000029482",
"simStatus": "Active",
"endpointStatus": "Active",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Active",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "BICS",
"readyForSms": "Yes",
"IsNRSecondary": "true",
"dependendRatType": "02|01|06|10",
"benefits": "Non_pooled_Dynamic_benefit_Reseller - non-pooled",
"benefitIds": "1335",
"imeiLockStatus": "UNLOCK",
"blacklistedNetworks": "No"
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "12/10/2021 06:29:02",
"expiryDate": "01/11/2021 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
},
{
"id": "5",
"name": "DATA",
"startDate": "12/10/2021 06:29:02",
"expiryDate": "13/11/2021 00:00:00",
"balance": "4194304",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "4194304",
"planId": "568677",
"planName": "new_addon_post",
"uniqueId": "13929",
"planCategory": "ADDON"
}
],
"dynamicBenefitsDetails": [
{
"name": "Non_pooled_Dynamic_benefit_Reseller",
"category": "2",
"dynamicBenefitsId": "1335",
"autoRenewal": "true",
"activationTime": "01/11/2021 00:05:52",
"expiryTime": "01/12/2021 00:00:00",
"priority": "1",
"benefitList": [
{
"benefitId": "1335",
"benefit": "1",
"ratezone": "10807",
"value": "1",
"priority": "1",
"balance": "3"
}
]
}
]
}
}
}
}Get Endpoint Profile - Success
{
"Response": {
"responseId": "21839040435971627",
"responseTimestamp": "09/11/2021 09:53:27",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "329999800078799",
"maBalance": "UNLIMITED",
"creationDate": "09/11/2021 10:52:20",
"currentStatus": "A",
"currentStatusName": "Active",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "574264",
"planName": "plan_new",
"imsi": "999980000078799",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "41663210",
"nextBillingDate": "01/12/2021 00:00:00",
"planEffectiveDate": "09/11/2021 10:52:20",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"apn": "sft1",
"roamingProfileId": "16189|16658",
"roamingProfileName": "DEFAULT|roaming_RP",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "301",
"iccid": "9990000000000078799",
"ratType": "10",
"ratTypeName": "2G/3G/4G/5G",
"name": "test_get",
"endPointId": "51664211",
"apnGroupId": "PDP_15700",
"currentActiveImsi": "999980000078799",
"simStatus": "Active",
"endpointStatus": "Active",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Active",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "BICS",
"readyForSms": "Yes",
"dependendRatType": "02|01|06|10",
"imeiLockStatus": "UNLOCK",
"blacklistedNetworks": "Yes"
},
"promotionalPlans": {
"plan": [
{
"planId": "599646",
"planName": "Adddon",
"planServiceId": "4",
"planServiceName": "COMBO",
"planStartDate": "09/11/2021 14:53:46",
"planExpiryDate": "01/12/2021 00:00:00",
"uniqueId": "12315"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "09/11/2021 10:52:20",
"expiryDate": "01/12/2021 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
},
{
"id": "2",
"name": "DATA",
"startDate": "09/11/2021 07:27:14",
"expiryDate": "01/12/2021 00:00:00",
"balance": "5242880",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "5242880",
"rateZoneId": "14295",
"planId": "599646",
"planName": "Adddon",
"uniqueId": "12315",
"planCategory": "ADDON"
}, {
"id": "4",
"name": "SMS",
"startDate": "09/11/2021 07:27:14",
"expiryDate": "01/12/2021 00:00:00",
"balance": "3",
"unitType": "COUNT",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "3",
"rateZoneId": "14294",
"planId": "599646",
"planName": "Adddon",
"uniqueId": "12315",
"planCategory": "ADDON"
}
]
}
}
}
}Get Endpoint Profile - Success {Example 1}
{
"Response": {
"responseId": "939613395306447",
"responseTimestamp": "28/03/2025 15:43:55",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "329999800404504",
"maBalance": "UNLIMITED",
"creationDate": "24/03/2025 10:15:38",
"currentStatus": "A",
"currentStatusName": "Active",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "DEFAULTPOST42149594",
"planName": "DEFAULT POSTPAID PLAN",
"imsi": "999980000404504",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "42149594",
"nextBillingDate": "01/04/2025 00:00:00",
"planEffectiveDate": "24/03/2025 10:15:38",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"customerType": "SFT",
"apn": "sft1",
"roamingProfileId": "110270",
"roamingProfileName": "DEFAULT",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "301",
"iccid": "9990000000000404504",
"ratType": "10",
"ratTypeName": "2G/3G/4G/5G",
"name": "EP_EID_1",
"endPointId": "52410983",
"apnGroupId": "PDP_47543",
"currentActiveImsi": "999980000404504",
"simStatus": "Active",
"lastSimStateChangeDateTime": "24/03/2025 10:15:38",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Active",
"simType": "Consumer IPP",
"simManufacture": "Valid",
"simApplet": "3468856",
"readyForSms": "Yes",
"dependendRatType": "02|01|06|10",
"imeiLockStatus": "UNLOCK",
"blacklistedNetworks": "No",
"enterpriseLTEMService": "Active",
"eid": "98623608848663686684539124144888",
"planExpiryDate": "31/12/2099 00:00:00",
"eSimProfileStatus": "enabled",
"rspState": "Global"
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "24/03/2025 10:15:38",
"expiryDate": "01/04/2025 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
}
]
}
}
}
}Get Endpoint Profile - Success {Endpoint with counter addon plan}
{
"Response": {
"responseId": "11519186344779358",
"responseTimestamp": "20/01/2025 03:16:11",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "327700040900111",
"maBalance": "UNLIMITED",
"creationDate": "17/01/2025 05:37:33",
"currentStatus": "A",
"currentStatusName": "Active",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "DEFAULTPOST42364402",
"planName": "DEFAULT POSTPAID PLAN",
"imsi": "206281000000111",
"subscriberType": "1",
"subscriberTypeName": "Postpaid",
"creditLimit": "UNLIMITED",
"parentEntityId": "42364402",
"nextBillingDate": "01/02/2025 00:00:00",
"imei": "358480583877289",
"planEffectiveDate": "17/01/2025 05:37:33",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"customerType": "SFT",
"apn": "bicsapn|sft1",
"roamingProfileId": "120186",
"roamingProfileName": "DEFAULT",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "301",
"iccid": "8932042000000000111",
"ratType": "06",
"ratTypeName": "2G/3G/4G",
"name": "endpoint1",
"endPointId": "52405754",
"apnGroupId": "PDP_49402",
"currentActiveImsi": "206281000000111",
"simStatus": "Active",
"lastSimStateChangeDateTime": "17/01/2025 05:37:33",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseNbiotService": "Active",
"enterpriseSMSService": "Active",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "NA",
"readyForSms": "No",
"dependendRatType": "02|01|06",
"framedIP": "100.64.4.129|100.64.4.80",
"imeiLockStatus": "UNLOCK",
"blacklistedNetworks": "No",
"enterpriseLTEMService": "Active"
},
"promotionalPlans": {
"plan": [
{
"planId": "795750",
"planName": "test_HT",
"planServiceId": "4",
"planServiceName": "COMBO",
"planStartDate": "17/01/2025 05:38:04",
"planExpiryDate": "21/01/2025 06:00:00",
"uniqueId": "56105"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "PostpaidMA",
"name": "Postpaid Main Account",
"startDate": "17/01/2025 05:37:33",
"expiryDate": "01/02/2025 00:00:00",
"balance": "UNLIMITED",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "UNLIMITED"
},
{
"id": "2",
"name": "DATA",
"startDate": "19/01/2025 06:00:41",
"expiryDate": "21/01/2025 06:00:00",
"balance": "33925534",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "41943040",
"planId": "795750",
"planName": "test_HT",
"uniqueId": "56105",
"planCategory": "ADDON"
}
]
},
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "20",
"action": "THROTTLE_128Kbps",
"planName": "DEFAULT POSTPAID PLAN",
"thresholdUnit": "MB",
"thresholdValue": "20",
"frequency": "Daily",
"factor": "1",
"resetDate": "21/01/2025 00:00:00",
"planId": "DEFAULTPOST42364402",
"addonPlanId": "795750",
"addonPlanName": "test_HT",
"addonUniqueId": "56105"
}
]
}
}
}EndPoint Profile - Success Example 2 — 200 — OK
{
"Response": {
"responseId": "46410691331469779",
"responseTimestamp": "10/05/2020 09:55:49",
"resultCode": "0",
"resultParam": {
"resultCode": "1082",
"resultDescription": "Get endpoint profile success"
},
"info": {
"basicInfo": {
"msisdn": "327700040900019",
"maBalance": "12056.2305",
"creationDate": "20/04/2020 15:35:01",
"language": "1",
"languageName": "ENGLISH",
"currentStatus": "A",
"currentStatusName": "Active",
"ocExpiryDate": "31/12/2099 00:00:00",
"planId": "DEFAULTPRE41166994",
"planName": "DEFAULT PREPAID PLAN",
"imsi": "206281000000019",
"subscriberType": "0",
"subscriberTypeName": "Prepaid",
"parentEntityId": "41166994",
"imei": "866674022570548",
"planEffectiveDate": "20/04/2020 15:35:01",
"planExpiryDate": "31/12/2099 00:00:00",
"currencyId": "44",
"currencyType": "EUR",
"tierId": "5",
"apn": "sft1",
"roamingProfileId": "125",
"roamingProfileName": "DEFAULT",
"pdpProfileName": "DEFAULT",
"customerExpiryDate": "31/12/2099 00:00:00",
"timeZoneId": "298",
"timeZoneName": "Europe/Belgrade",
"iccid": "8932042000000000019",
"ratType": "06",
"ratTypeName": "2G/3G/4G",
"name": "mvneaccount",
"endPointId": "51170448",
"apnGroupId": "PDP_1248",
"currentActiveImsi": "206281000000019",
"simStatus": "Active",
"endpointStatus": "Active",
"enterpriseAccountStatus": "Enabled",
"enterpriseDataService": "Active",
"enterpriseSMSService": "Active",
"enterpriseNbiotService": "Active",
"simType": "UICC",
"simManufacture": "Valid",
"simApplet": "NA",
"readyForSms": "Yes",
"dependendRatType": "02|01|06|08",
"framedIP": "100.64.0.53|100.64.0.13",
"dynamicBenefitEnable": "true",
"benefits": "MultipleDynamicBenefitsTestingForENterprises",
"benefitIds": "1568",
"imeiLockStatus": "UNLOCK"
},
"promotionalPlans": {
"plan": [
{
"planId": "560510",
"planName": "SBI05",
"planServiceId": "4",
"planServiceName": "COMBO",
"planStartDate": "12/08/2020 12:17:50",
"planExpiryDate": "13/08/2020 13:00:00",
"uniqueId": "1737"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "MA",
"name": "Main Account",
"startDate": "20/04/2020 15:35:01",
"expiryDate": "31/12/2099 00:00:00",
"balance": "12056.2305",
"unitType": "MONEY",
"type": "Main Account",
"actualBalance": "20000"
},
{
"id": "2",
"name": "DATA",
"startDate": "12/08/2020 12:17:50",
"expiryDate": "13/08/2020 13:00:00",
"balance": "20971520",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)",
"actualBalance": "20971520",
"rateZoneId": "1739",
"rateZoneName": "India"
}
]
},
"counter": [
{
"counterId": "C_Daily_0_CE_USAGE_VOLUME_4_5_191",
"counterName": "Daily",
"usage": "100",
"action": "THROTTLE_512Kbps",
"thresholdUnit": "MB",
"frequency": "Daily",
"factor": "1",
"thresholdValue": "150"
}
]
}
}
}Endpoint - Geolocation
Path: Endpoint / Endpoint - Geolocation
Method: GET
URL: https://sft.bics.com/api/locationInfo?endPointId=51486859
Description
The check Geolocation API provides the enterprise customer with the means to retrieve the location of any of it's endpoints.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Query Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | CM | Id of an endpoint <br>Note: At least one query parameter should be present in the URI(endpointId/msisdn/iccid/imsi) |
msisdn | CM | MSISDN of an endpoint |
iccid | CM | ICCID of an endpoint |
imsi | CM | IMSI of an endpoint |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of the result, contains result code and description |
responseParam | O | Object of the Geolocation Details. <br>If any error occurred during fetch, this field will not be there. |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output responseParam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
imsi | O | If geolocation retrival is success, get the corresponding IMSI - This will be the master IMSI |
geolocation | O | Contains information about location of an endpoint |
Output geolocation Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
cellIdRatType | O | This field shows the information of the Radio Access type from which Location Information is retrieved (this is not necessarily the RAT type to which the Subscriber is connected) |
locationInfoAge | O | Location information Age |
mcc | O | The cell tower's Mobile Country Code |
mnc | O | The cell tower's Mobile Network Code |
cellId | O | Cell ID based on the RAT Type (in Decimal format) |
lac | O | Location area code (in Decimal format) |
tac | O | Type allocation code of the LTE customer (in Decimal format) |
countryName | O | Country Name |
operatorName | O | Operator name |
Result Codes
Result Codes | Description | |
|---|---|---|
10084 | Location info - success | |
10085 | Location info - failure | |
10087 | HSS connection failed | |
10088 | Failure!! request to HSS timed out | |
10089 | Endpoint is detached | |
10094 | No geolocation information was provided by visited network | |
11055 | Geolocation cannot be retrieved for the endpoints with RSP State = Local |
Headers
Header | Value |
|---|---|
|
|
|
|
|
|
Query Parameters
Parameter | Value | Description |
|---|---|---|
|
|
Response Examples
Geolocation Information - Failure {Timeout scenario}
{
"Response": {
"resultParam": {
"resultCode": "10088",
"resultDescription": "Failure!! request to HSS timed out"
},
"resultCode": "1",
"responseId": "3899578866804841",
"responseTimestamp": "11/09/2020 22:00:27"
}
}Geolocation Information - Failure {Insufficient privilege}
{
"Response": {
"resultParam": {
"resultCode": "10002",
"resultDescription": "Insufficient privilege"
},
"resultCode": "1",
"responseId": "3022401262068480",
"responseTimestamp": "09/09/2020 16:13:20"
}
}Geolocation Information - Success {endPointId} — 200 — OK
{
"Response": {
"resultParam": {
"resultCode": "10084",
"resultDescription": "Location info - success"
},
"resultCode": "0",
"responseParam": {
"imsi": "206281000000004",
"geolocation": {
"cellIdRatType": "4G",
"locationInfoAge": "0",
"mcc": "206",
"mnc": "01",
"cellId": "21441025",
"tac": "4209",
"countryName": "Belgium",
"operatorName": "Proximus"
}
},
"responseId": "2999711556257131",
"responseTimestamp": "09/09/2020 09:55:14"
}
}Geolocation Information - Failure {No geolocation data provided by HSS}
{
"Response": {
"resultParam": {
"resultCode": "10094",
"resultDescription": "No geolocation information was provided by visited network"
},
"resultCode": "1",
"responseId": "1193228093888944",
"responseTimestamp": "15/10/2020 15:56:20"
}
}Geolocation Information - Failure {other than 200 OK response from HSS}
{
"Response": {
"resultParam": {
"resultCode": "10087",
"resultDescription": "HSS connection failed"
},
"resultCode": "1",
"responseId": "3899804981478839",
"responseTimestamp": "11/09/2020 22:03:12"
}
}Geolocation Information - Failure {Endpoint is detached}
{
"Response": {
"resultParam": {
"resultCode": "10089",
"resultDescription": "Endpoint is detached"
},
"resultCode": "1",
"responseId": "8279018513355183",
"responseTimestamp": "19/09/2022 03:04:24"
}
}Endpoint Coverage
Path: Endpoint / Endpoint Coverage
Method: GET
URL: https://sft.bics.com/api/endpointCoverage?endPointId=51698724
Description
To fetch coverage for an endpoint. The output of this API will be identical to the one retrieved via GUI on Endpoint Diagnostics → View Network Coverage.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Query Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
endPointId | CM | End Point ID |
msisdn | CM | MSISDN of an endpoint |
iccid | CM | ICCID of an endpoint |
imsi | CM | IMSI of an endpoint |
blacklisted | O | True - lists (only) all the blacklisted networks for that endpoint <br>False - lists (only) all the networks <br>which are not blacklisted for that endpoint |
Note: At least one of the following query parameters should be present in the URI: endpointId/msisdn/iccid/imsi
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | API result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output responseparam Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
coverage | M | Lists of Networks |
Output coverage Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
tadigCode | M | TADIG Code |
operatorId | M | Id of Operator |
operatorName | M | Name of Operator |
category | M | Category, it is a supplier category <br>0 - IR <br>1 - OC <br>2 - Direct |
categoryGroupName | M | Reference to network relation |
categoryGroupId | M | Category Group ID |
countryName | M | Country Name |
mccMnc | M | MCC MNC |
barredUnbarredStatus | M | Barred Unbarred Status <br>0 - Unbarred <br>1 - Barred |
blacklisted | M | Network blacklisting status <br>true - The network is blacklisted <br>false - The network is not blacklisted |
supportedNetworkTypes | M | Network types supported by the network, separated by a pipe |
roamingProfileId | M | Details the ID of Roaming Profile linked to that endpoint is this network attached |
roamingProfileName | M | Details the Name of Roaming Profile linked to that endpoint is this network attached |
barredRATs | M | List of Barred Radio Access Technologies for that operator Possible values are {2G,3G,4G,NBIOT} |
supplierPriority | O | Determines the priority of a given network. <br>Available values being 1, 2, and 3—where 1 is the highest priority. <br>Additionally, the value "B" indicates that the Network-Sponsor should be used solely as bootstrap, meaning that this sponsor should only be used to download the preferred IMSI for the country |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10132 | Get endpoint coverage success | |
10133 | Get endpoint coverage failure |
Headers
Header | Value |
|---|---|
|
|
|
|
Query Parameters
Parameter | Value | Description |
|---|---|---|
|
|
Response Examples
endpointCoverage - Success
{
"Response": {
"resultParam": {
"resultCode": "10132",
"resultDescription": "Get endpoint coverage success"
},
"resultCode": "0",
"responseParam": {
"coverage": [
{
"tadigCode": "AUTCA",
"operatorId": "210",
"operatorName": "Hutchison Drei",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "Austria",
"mccMnc": "23205",
"barredUnbarredStatus": "0",
"blacklisted": "false",
"supportedNetworkTypes": "2G|3G|4G|5G",
"barredRATs": "-",
"roamingProfileId": "29629",
"roamingProfileName": "CustomRp3",
"supplierPriority": "2"
},
{
"tadigCode": "CZECM",
"operatorId": "235",
"operatorName": "Vodafone Czech Republic",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "Czech Republic",
"mccMnc": "23003",
"barredUnbarredStatus": "0",
"blacklisted": "false",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "2G",
"roamingProfileId": "29629",
"roamingProfileName": "CustomRp3"
}
]
},
"responseId": "14845308968563656",
"responseTimestamp": "13/06/2022 10:09:50"
}
}endpointCoverage - Success - network barred in roaming profile and blacklisted
{
"Response": {
"resultParam": {
"resultCode": "10132",
"resultDescription": "Get endpoint coverage success"
},
"resultCode": "0",
"responseParam": {
"coverage": [
{
"tadigCode": "USAAT",
"operatorId": "208",
"operatorName": " AT&T ",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "United States",
"mccMnc": "310380",
"barredUnbarredStatus": "0",
"blacklisted": "false",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "3G",
"roamingProfileId": "35443",
"roamingProfileName": "CustomRP1",
"supplierPriority":"1"
},
{
"tadigCode": "CHEC1",
"operatorId": "224",
"operatorName": "Swisscom",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "Switzerland",
"mccMnc": "22801",
"barredUnbarredStatus": "0",
"blacklisted": "false",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "-",
"roamingProfileId": "35445",
"roamingProfileName": "CustomRP3"
},
{
"tadigCode": "INDHM",
"operatorId": "237",
"operatorName": "Vodafone india",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "India",
"mccMnc": "40486,40419,40420",
"barredUnbarredStatus": "0",
"blacklisted": "false",
"supportedNetworkTypes": "2G|3G|4G",
"barredRATs": "-",
"roamingProfileId": "35443",
"roamingProfileName": "CustomRP1"
},
{
"tadigCode": "UKRKS",
"operatorId": "215",
"operatorName": "Kyivstar",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "Ukraine",
"mccMnc": "25503",
"barredUnbarredStatus": "0",
"blacklisted": "true",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT",
"barredRATs": "-",
"roamingProfileId": "35443",
"roamingProfileName": "CustomRP1"
},
{
"tadigCode": "UKRKS",
"operatorId": "215",
"operatorName": "Kyivstar",
"category": "0",
"categoryGroupName": "IR1",
"categoryGroupId": "SP14073",
"countryName": "Ukraine",
"mccMnc": "25503",
"barredUnbarredStatus": "1",
"blacklisted": "true",
"supportedNetworkTypes": "2G|3G|4G|5G|NB-IOT",
"barredRATs": "-",
"roamingProfileId": "35445",
"roamingProfileName": "CustomRP3"
}
]
},
"responseId": "4673592851696714",
"responseTimestamp": "08/08/2022 13:12:33"
}
}endpointCoverage - Failure
{
"Response": {
"resultParam": {
"resultCode": "10133",
"resultDescription": "Get endpoint coverage failure"
},
"resultCode": "1",
"responseId": "4675736422587812",
"responseTimestamp": "08/08/2022 13:48:16"
}
}endpointCoverage - Failure - Without query parameters
{
"Response": {
"resultParam": {
"resultCode": "1000",
"resultDescription": "Mandatory parameter missing -msisdn/endPointId/iccid/imsi"
},
"resultCode": "1",
"responseId": "4678863246423116",
"responseTimestamp": "08/08/2022 14:40:23"
}
}EndPoint - Blacklisting
Path: Endpoint / EndPoint - Blacklisting
Method: POST
URL: https://sft.bics.com/api/endPointBlacklisting
Description
This API is used for adding or removing networks from the black list of the endpoint.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
coverageBlacklistInfo | M | Object containing the Id of the endpoint for which the blacklist will be modified and the actual change |
Input coverageBlacklistInfo Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resourceType | M | Used for defining the type of information that will be provided under the parameter "value" (see below) <br>Possible values: <br>- endPointId <br>- msisdn <br>- imsi <br>- iccid |
value | M | Value that will be used to identify the endpoint that will be modified. The type of the ID is specified in “resourceType” |
add | CM | List containing the networks which will be added to the endpoint’s blacklist. |
remove | CM | List containing the networks which will be removed from the endpoint’s blacklist. |
Note: At least one of the objects “add” or “remove” have to be present on the user’s query
Input add/remove Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
tadigCode | M | The TADIG codes of the networks that will be added or removed from the Endpoint’s blacklist |
categoryGroupId | M | The Category Group of the sponsor for which the aforementioned network has to be added or removed from the blacklist |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 - Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10135 | Endpoint blacklist modification success | |
10136 | Endpoint blacklist modification failure |
Headers
Header | Value |
|---|---|
|
|
|
|
Response Examples
endPointBlacklisting - Success
{
"Response": {
"resultParam": {
"resultCode": "10135",
"resultDescription": "Endpoint blacklist modification success"
},
"resultCode": "0",
"responseId": "14774958246497856",
"responseTimestamp": "13/06/2022 14:06:53"
}
}endPointBlacklisting - Failure - Same network for add and remove array
{
"Response": {
"resultParam": {
"resultCode": "10134",
"resultDescription": "Modify endpoint(s) failure - Cannot add and remove the same network"
},
"resultCode": "1",
"responseId": "4672735732613202",
"responseTimestamp": "08/08/2022 12:58:15"
}
}endPointBlacklisting - Failure - Passing network in remove array which is not blacklisted
{
"Response": {
"resultParam": {
"resultCode": "10134",
"resultDescription": "Modify endpoint(s) failure - No network available to remove"
},
"resultCode": "1",
"responseId": "4672782860472533",
"responseTimestamp": "08/08/2022 12:59:03"
}
}endPointBlacklisting - Failure - Passing network in add array which is already blacklisted
{
"Response": {
"resultParam": {
"resultCode": "10134",
"resultDescription": "Modify endpoint(s) failure - already blacklisted networks are present in add list"
},
"resultCode": "1",
"responseId": "4675736422587812",
"responseTimestamp": "08/08/2022 13:48:16"
}
}EndPoint - Blacklisting
No response body provided.
fetchNetworkStatus
Path: Endpoint / fetchNetworkStatus
Method: GET
URL: https://sft.bics.com/api/fetchNetworkStatus?imsi=206281000000018
Description
Using this API, user can fetch the connectivity status of an given endpoint. The network information are available in the API response. If no network information can be returned, either because there is no recent information, no information at all or if there has been an internal error.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Query parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | CM | Id of an endpoint |
msisdn | CM | MSISDN of an endpoint |
imsi | CM | IMSI of an endpoint |
iccid | CM | ICCID of an endpoint |
One query parameter should be used to specify the endpoint for which the connectivity info should be fetched. That is why the fields in the table above are indicated as Conditional Mandatory.
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of the result, contains result code and description |
responseParam | O | Object of the fetchNetworkStatus details. This object will not be shown if resultCode above = 1. Same as with the Check Geolocation API |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output responseParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
imsi | M | IMSI of the SIM card selected by the user |
networkStatusInfo | M | Network Information Object |
Output networkStatusInfo
Field | Optional/ Mandatory | Description |
|---|---|---|
tadigCode | M | TADIG Code of the network visited by the Subscriber |
operatorName | M | Name of the operator visited by the Subscriber |
countryName | M | Name of the Country served by the operator visited by the Subscriber. |
networkStatus | M | Connectivity status of the Endpoint, e.g. “Connected” |
networkType | M | Radio Access Type used by the Subscriber at the moment, <br> <br>Network Type: <br>2G/3G - Endpoint is connected to 2G or 3G. <br>4G - Endpoint is connected to 4G. <br>5G - Endpoint is connected to 5G |
operatorMCC | M | MCC of the operator visited by the Subscriber |
operatorMNC | M | MNC of the operator visited by the Subscriber |
policyStatus | O | This parameter will only be provided in Connected state. <br>If the PolicyName=BLOCKED then policyStatus=Blocked, if DEFAULT policy then, policyStatus=Default, and if anything other than DEFAULT/BLOCKED then it should be Throttle. |
New Result Codes
Result Codes | Description |
|---|---|
11008 | Network Status info - success |
11009 | Network Status info - failure |
11010 | There is no recent network info for this endpoint |
2503 | Subscriber not in active state |
10097 | Multiple query parameters are not allowed |
Headers
Header | Value |
|---|---|
|
|
Query Parameters
Parameter | Value | Description |
|---|---|---|
|
|
Response Examples
fetchNetworkStatus - Success Not Connected
"Response": {
"resultParam": {
"resultCode": "11008",
"resultDescription": "Network Status info - success"
},
"resultCode": "0",
"responseParam": {
"imsi": "206281000000004",
"networkStatusInfo": {
"countryName": "India",
"operatorMCC": "404",
"operatorMNC": "45",
"tadigCode": "-",
"operatorName": "Airtel india",
"networkStatus": "Not Connected",
"networkType": "2G/3G"
}
},
"responseId": "7693062644406533",
"responseTimestamp": "20/06/2023 10:35:37"
}
}fetchNetworkStatus - Success Connected
{
"Response": {
"resultParam": {
"resultCode": "11008",
"resultDescription": "Network Status info - success"
},
"resultCode": "0",
"responseParam": {
"imsi": "206281000000018",
"networkStatusInfo": {
"policyStatus":"Default",
"countryName": "India",
"operatorMCC": "404",
"operatorMNC": "45",
"tadigCode": "INDSC",
"operatorName": "Airtel india",
"networkStatus": "Connected",
"networkType": "5G"
}
},
"responseId": "7362099981634183",
"responseTimestamp": "16/06/2023 14:39:34"
}
}fetchNetworkStatus - Success - RSP State = Local
{
"Response": {
"resultParam": {
"resultCode": "11008",
"resultDescription": "Network Status info - success"
},
"resultCode": "0",
"responseParam": {
"imsi": "-",
"networkStatusInfo": {
"countryName": "India",
"operatorMCC": "404",
"operatorMNC": "07",
"tadigCode": "INDHM",
"operatorName": "Vodafone india",
"networkStatus": "Last Seen On 03/09/2025 17:14:27",
"networkType": "-"
}
},
"responseId": "1729210501967887",
"responseTimestamp": "03/09/2025 07:59:36"
}
}fetchNetworkStatus - Failure
{
"Response": {
"resultParam": {
"resultCode": "11009",
"resultDescription": "Network Status info - failure"
},
"resultCode": "1",
"responseId": "7694837262241154",
"responseTimestamp": "20/06/2023 11:05:11"
}
}fetchNetworkStatus - Failure no recent info
{
"Response": {
"resultParam": {
"resultCode": "11010",
"resultDescription": "There is no recent network info for this endpoint"
},
"resultCode": "1",
"responseId": "7693510882949410",
"responseTimestamp": "20/06/2023 10:49:55"
}
}fetchNetworkStatus - Failure not active
{
"Response": {
"resultParam": {
"resultCode": "2503",
"resultDescription": "Subscriber not in active state"
},
"resultCode": "1",
"responseId": "7694837262241154",
"responseTimestamp": "20/06/2023 11:05:11"
}
}SubscribeAddon
Path: Endpoint / SubscribeAddon
Method: POST
URL: https://sft.bics.com/api/SubscribeAddon
Subscribe Addon
This operation is available for Enterprises and supports only one Addon per request (bulk assignment is not supported). The process is synchronous, and the response includes, among other parameters, the Addon's unique identifier (uniqueID), which can be used to retrieve detailed information about the assigned Addon.
Enterprises can adjust the available benefit units of an addon plan at the time of subscription. This enables flexible balance management during the addon’s validity period, including partial provisioning for trials or promotional offers.
NOTE!! At the end of the validity period, the addon benefit <u><b> automatically resets to its full value</b></u> upon renewal.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Input Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Request | M | Object of request details |
Input Request Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
requestParam | M | Object of endpoint details |
Input requestParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endPointId | M | ID of the endpoint |
planId | M | ID of the planId |
benefit | O | Array of benefits |
Input benefit Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
id | CM | Benefit Id <br>Can fetch the details of possible benefitId using "Get Benefit" API |
balance | CM | balance value that is being adjusted (Mb) |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Result code <br>0– Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output info Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
basicInfo | O | Object of Basic Info |
benefitInfo | O | List of benefit Objects |
counter | O | List of counter details |
promotionalPlans | O | List of promotional plans |
Output promotionalPlans Parameters (ADDON PLAN)
Field | Optional/ Mandatory | Description |
|---|---|---|
plan | O | List of Add-on Plans Plans associated with the endpoint |
Output plan Parameters (ADDON PLAN)
Field | Optional/ Mandatory | Description |
|---|---|---|
planId | O | Add-on Plan ID |
planName | O | Add-on Plan Name |
planServiceId | O | Add-on Plan Service ID |
planServiceName | O | Add-on Plan Service Name |
planStartDate | O | Add-on Plan Start Date Format:dd/mm/yyyy hh:mm:ss |
planExpiryDate | O | Add-on Plan Expiry Date Format:dd/mm/yyyy hh:mm:ss |
uniqueId | O | UniqueId of the Addon for which the Endpoint Subscribed |
Output benefitInfo Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
benefit | O | List of benefit associated with end point |
Output benefit Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
id | O | Benefit ID |
name | O | Benefit Name |
startDate | O | Start Date <br>Format: dd/mm/yyyy hh:mm:ss |
expiryDate | O | Expiry Date <br>Format: dd/mm/yyyy hh:mm:ss |
balance | O | Balance. The value depends on the "type" and the "unitType" of the benefit <br>For example <br>- If the "type": "Main Account", then the "balance" value can be UNLIMITED string or digits (in cents). <br>- If the "type": "ADDON-ACCOUNT (FREE)" & "unitType": "MB", then the "balance" value will be in bytes <br>- If the "type": "ADDON-ACCOUNT (FREE)" & "unitType": "COUNT", then the "balance" value will be in count. |
unitType | O | Unit Type. Possible Values: <br>- COUNT (for SMS) <br>- Mb (for Data) |
type | O | Type of the Benefit. Possible Values: <br>- ADDON-ACCOUNT (MONEY) <br>- ADDON-ACCOUNT (FREE) <br>- Main Account |
actualBalance | O | Account Actual/Initial Balance |
Output counter Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
counterId | O | Counter Id |
counterName | O | Counter Name |
usage | O | Left over Usage in MB |
limit | O | Threshold Value in bytes |
action | O | Action |
thresholdUnit | O | Threshold Unit |
frequency | O | Frequency |
factor | O | factor |
thresholdValue | O | Threshold Value |
resetDate | O | When the counter will be reset. Format: dd/mm/yyyy hh:mm:ss |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
1171 | Addon subscription success | |
1172 | Addon subscription failure | |
10260 | Failed..! Adjusted balance is lesser than the Counter value |
Example:
{
"Request": {
"requestParam": {
"endPointId": "5678433",
"planId": "599646"
}
}
}
Response
The response to the request will contain the relevant subscription details.
Response Examples
SubscribeAddon-Subscribed and actived
{
"Response": {
"responseId": "5371461366950698",
"responseTimestamp": "04/02/2025 06:27:23",
"resultCode": "0",
"resultParam": {
"resultCode": "1171",
"resultDescription": "Addon subscription success"
},
"info": {
"promotionalPlans": {
"plan": [
{
"planId": "12345",
"planName": "Adddon",
"planServiceId": "4",
"planServiceName": "COMBO",
"planStartDate": "09/11/2021 14:53:46",
"planExpiryDate": "01/12/2021 00:00:00",
"uniqueId": "54321"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "04/02/2025 10:37:34",
"expiryDate": "14/02/2025 11:00:00",
"balance": "5242880",
"actualBalance": "5242880",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
},
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "3",
"limit": "3145728",
"action": "THROTTLE_512Kbps",
"thresholdUnit": "MB",
"thresholdValue": "3",
"frequency": "Daily",
"factor": "1",
"resetDate": "05/02/2025 00:00:00"
}
]
}
}
}SubscribeAddon-Subscribed and not actived(On Usage)
{
"Response": {
"responseId": "5371461366950698",
"responseTimestamp": "04/02/2025 06:27:23",
"resultCode": "0",
"resultParam": {
"resultCode": "1171",
"resultDescription": "Addon subscription success"
},
"info": {
"promotionalPlans": {
"plan": [
{
"planId": "123456",
"planName": "Adddon",
"planServiceId": "4",
"planServiceName": "COMBO",
"uniqueId": "654321"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "5242880",
"actualBalance": "5242880",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
},
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "0",
"limit": "3145728",
"action": "THROTTLE_512Kbps",
"thresholdUnit": "MB",
"thresholdValue": "3",
"frequency": "Daily",
"factor": "1",
"resetDate": "-"
}
]
}
}
}SubscribeAddon-Subscribed to OEM
{
"Response": {
"responseId": "5371461366950698",
"responseTimestamp": "04/02/2025 06:27:23",
"resultCode": "0",
"resultParam": {
"resultCode": "1171",
"resultDescription": "Addon subscription success"
},
"info": {
"promotionalPlans": {
"plan": [
{
"planId": "123456",
"planName": "Adddon",
"planServiceId": "4",
"planServiceName": "COMBO"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "5242880",
"actualBalance": "5242880",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
}
}
}
}SubscribeAddon - Adjusted balance less than the actualbalance
{
"Response": {
"responseId": "01761200984064324",
"responseTimestamp": "23/10/2025 08:29:44",
"resultCode": "0",
"resultParam": {
"resultCode": "1171",
"resultDescription": "Addon subscription success"
},
"info": {
"promotionalPlans": {
"plan": [
{
"planId": "843543",
"planName": "AddonPlanwithAllBenefits",
"planServiceId": "4",
"planServiceName": "COMBO",
"planStartDate": "23/10/2025 08:29:44",
"planExpiryDate": "24/10/2025 09:00:00",
"uniqueId": "65660"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "4",
"name": "SMS",
"startDate": "23/10/2025 08:29:44",
"expiryDate": "24/10/2025 09:00:00",
"balance": "3",
"actualBalance": "5",
"unitType": "COUNT",
"type": "ADDON-ACCOUNT (FREE)"
},
{
"id": "2001",
"name": "NB-IOT",
"startDate": "23/10/2025 08:29:44",
"expiryDate": "24/10/2025 09:00:00",
"balance": "1048576",
"actualBalance": "3145728",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
},
{
"id": "2",
"name": "DATA",
"startDate": "23/10/2025 08:29:44",
"expiryDate": "24/10/2025 09:00:00",
"balance": "26214400",
"actualBalance": "31457280",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
},
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "20",
"limit": "20971520",
"action": "THROTTLE_512Kbps",
"thresholdUnit": "MB",
"thresholdValue": "20",
"frequency": "Daily",
"factor": "1",
"resetDate": "24/10/2025 00:00:00"
}
]
}
}
}SubscribeAddon - Adjusted balance greater than the actualbalance
{
"Response": {
"responseId": "01761200984064324",
"responseTimestamp": "23/10/2025 08:29:44",
"resultCode": "0",
"resultParam": {
"resultCode": "1171",
"resultDescription": "Addon subscription success"
},
"info": {
"promotionalPlans": {
"plan": [
{
"planId": "843543",
"planName": "AddonPlanwithAllBenefits",
"planServiceId": "4",
"planServiceName": "COMBO",
"planStartDate": "23/10/2025 08:29:44",
"planExpiryDate": "24/10/2025 09:00:00",
"uniqueId": "65660"
}
]
},
"benefitInfo": {
"benefit": [
{
"id": "4",
"name": "SMS",
"startDate": "23/10/2025 08:29:44",
"expiryDate": "24/10/2025 09:00:00",
"balance": "6",
"actualBalance": "6",
"unitType": "COUNT",
"type": "ADDON-ACCOUNT (FREE)"
},
{
"id": "2001",
"name": "NB-IOT",
"startDate": "23/10/2025 08:29:44",
"expiryDate": "24/10/2025 09:00:00",
"balance": "8388608",
"actualBalance": "8388608",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
},
{
"id": "2",
"name": "DATA",
"startDate": "23/10/2025 08:29:44",
"expiryDate": "24/10/2025 09:00:00",
"balance": "41943040",
"actualBalance": "41943040",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
},
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "20",
"limit": "20971520",
"action": "THROTTLE_512Kbps",
"thresholdUnit": "MB",
"thresholdValue": "20",
"frequency": "Daily",
"factor": "1",
"resetDate": "24/10/2025 00:00:00"
}
]
}
}
}SubscribeAddon - Adjusted balance less than the counter value
{
"Response": {
"responseId": "11761143359322817",
"responseTimestamp": "22/10/2025 16:29:19",
"resultCode": "1",
"resultParam": {
"resultCode": "10260",
"resultDescription": "Failed..! Adjusted balance is lesser than the Counter value"
}
}
}Endpoint - Addon Details
Path: Endpoint / Endpoint - Addon Details
Method: GET
URL: https://sft.bics.com/api/GetEndpointAddonDetails?endPointId=01010101
Description
Get Endpoint Addon Details API is used to fetch the Endpoint addon details from the platform.
Account Access
Account Type | Access | Comments |
|---|---|---|
Reseller | No | |
Enterprise | Yes |
Input
Query Parameters
Field | Optional/Mandatory | Description |
|---|---|---|
endPointId | M | End Point ID |
addonId | O | Id of the addon plan |
uniqueId | O | uniqueid of the addon plan |
Output
Output Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
Response | M | Object of response details |
Output Response Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | API result code <br>0 – Success <br>1 – Failure |
responseId | M | Response Transaction ID |
responseTimestamp | M | Response initiated time Format: dd/mm/yyyy hh:mm:ss |
resultParam | M | Object of transaction result |
info | O | Object of end point Info details |
Output resultParam Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
resultCode | M | Status/Error Code |
resultDescription | M | Status/Error Description |
Output info Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
info | O | Object of Basic Info |
benefit | O | List of benefit Objects |
counter | O | List of counter details |
Output Info Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
endpointid | O | Endpointid passed in the query parameter |
OUTPUT PROMOTIONALPLANS PARAMETERS (ADDON PLAN)
Field | Optional/ Mandatory | Description |
|---|---|---|
plan | O | List of Add-on Plans Plans associated with the endpoint |
OUTPUT PLAN PARAMETERS (ADDON PLAN)
Field | Optional/ Mandatory | Description |
|---|---|---|
planId | O | Add-on Plan ID |
planName | O | Add-on Plan Name |
uniqueId | O | UniqueId of the Addon for which the Endpoint Subscribed |
Output benefit Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
id | O | Benefit ID |
name | O | Benefit Name |
startDate | O | Start Date <br>Format: dd/mm/yyyy hh:mm:ss |
expiryDate | O | Expiry Date <br>Format: dd/mm/yyyy hh:mm:ss |
balance | O | Balance. The value depends on the "type" and the "unitType" of the benefit <br>For example <br>- If the "type": "Main Account", then the "balance" value can be UNLIMITED string or digits (in cents). <br>- If the "type": "ADDON-ACCOUNT (FREE)" & "unitType": "MB", then the "balance" value will be in bytes <br>- If the "type": "ADDON-ACCOUNT (FREE)" & "unitType": "COUNT", then the "balance" value will be in count. |
unitType | O | Unit Type. Possible Values: <br>- Count (for SMS) <br>- MB (for Data) |
type | O | Type of the Benefit. Possible Values: <br>- ADDON-ACCOUNT (MONEY) <br>- ADDON-ACCOUNT (FREE) <br>- Main Account |
actualBalance | O | Account Actual/Initial Balance |
Output counter Parameters
Field | Optional/ Mandatory | Description |
|---|---|---|
counterId | O | Counter Id |
counterName | O | Counter Name |
usage | O | Left over Usage in MB |
action | O | Action |
thresholdUnit | O | Threshold Unit |
frequency | O | Frequency |
factor | O | factor |
thresholdValue | O | Threshold Value |
resetDate | O | When the counter will be reset. Format: dd/mm/yyyy hh:mm:ss |
Result Codes
Result Codes | Description | Next Steps |
|---|---|---|
10255 | Get endpoint addon details success | |
10257 | Addon Not available |
Headers
Header | Value |
|---|---|
|
|
|
|
Query Parameters
Parameter | Value | Description |
|---|---|---|
|
|
Response Examples
Get Endpoint Profile - Success
{
"Response": {
"responseId": "1892892225840869",
"responseTimestamp": "05/09/2025 05:21:29",
"resultCode": "0",
"resultParam": {
"resultCode": "10255",
"resultDescription": "Get Endpoint Addon Details success"
},
"info": {
"endpointId": "01010101",
"promotionalPlans": {
"plan": [
{
"planId": "0101",
"planName": "addon_c",
"uniqueId": "01010",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
},
{
"planId": "838834",
"planName": "addon_b",
"uniqueId": "64908",
"benefit": [
{
"id": "56784",
"name": "sample4",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
]
},
{
"planId": "838833",
"planName": "addon_a",
"uniqueId": "64907",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "15728640",
"actualBalance": "15728640",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "10",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "10",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
},
{
"planId": "838864",
"planName": "addon_e",
"uniqueId": "64911",
"benefit": [
{
"id": "222",
"name": "nbiot-test",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "5",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "5",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
},
{
"planId": "838868",
"planName": "addon_i",
"uniqueId": "64913",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_NBIOT_VOLUME_5_5_711",
"counterName": "Daily_NB-IoT",
"usage": "5",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "5",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
},
{
"planId": "838867",
"planName": "test_plan_h",
"uniqueId": "64916",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_NBIOT_VOLUME_5_5_711",
"counterName": "Daily_NB-IoT",
"usage": "10",
"action": "THROTTLE_384Kbps",
"thresholdUnit": "MB",
"thresholdValue": "10",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
},
{
"planId": "838865",
"planName": "planaddon_f",
"uniqueId": "64915",
"benefit": [
{
"id": "35435",
"name": "DATA90",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "5",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "5",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
},
{
"planId": "838869",
"planName": "addon_j",
"uniqueId": "64914",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "5",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "5",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
},
{
"planId": "838866",
"planName": "addon_g",
"uniqueId": "64912",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "-",
"expiryDate": "-",
"balance": "10485760",
"actualBalance": "10485760",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "5",
"action": "THROTTLE_384Kbps",
"thresholdUnit": "MB",
"thresholdValue": "5",
"frequency": "Daily",
"factor": "1",
"resetDate": "-"
}
]
},
{
"planId": "838863",
"planName": "addon_d",
"uniqueId": "64910",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "5242880",
"actualBalance": "5242880",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "5",
"action": "THROTTLE_512Kbps",
"thresholdUnit": "MB",
"thresholdValue": "5",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
}
]
}
}
}
}Get Endpoint Profile - Success
{
"Response": {
"responseId": "1893564687587911",
"responseTimestamp": "05/09/2025 05:32:42",
"resultCode": "0",
"resultParam": {
"resultCode": "10255",
"resultDescription": "Get Endpoint Addon Details success"
},
"info": {
"endpointId": "01010101",
"promotionalPlans": {
"plan": [
{
"planId": "0101",
"planName": "addon_a",
"uniqueId": "01010",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "15728640",
"actualBalance": "15728640",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "10",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "10",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
}
]
}
}
}
}Get Endpoint Profile - Success
{
"Response": {
"responseId": "1893564687587911",
"responseTimestamp": "05/09/2025 05:32:42",
"resultCode": "0",
"resultParam": {
"resultCode": "10255",
"resultDescription": "Get Endpoint Addon Details success"
},
"info": {
"endpointId": "01010101",
"promotionalPlans": {
"plan": [
{
"planId": "0101",
"planName": "addon_a",
"uniqueId": "01010",
"benefit": [
{
"id": "2",
"name": "DATA",
"startDate": "03/09/2025 23:08:26",
"expiryDate": "31/12/2099 00:00:00",
"balance": "01010101",
"actualBalance": "15728640",
"unitType": "Mb",
"type": "ADDON-ACCOUNT (FREE)"
}
],
"counter": [
{
"counterId": "C_Daily_1_CE_USAGE_VOLUME_4_5_108",
"counterName": "Daily_DATA",
"usage": "10",
"action": "DEFAULT",
"thresholdUnit": "MB",
"thresholdValue": "10",
"frequency": "Daily",
"factor": "1",
"resetDate": "04/09/2025 00:00:00"
}
]
}
]
}
}
}
}