17. Enterprise Tools

This page contains all documentation under this Postman category.

Additional usage notes

Enterprise tools typically reference enterpriseId / organisationId via GET Organisation.
Enterprise tools may reference endpointId via GET Endpoint.
Enterprise tools may reference planId via GET Query Rate Plan.
Endpoint-specific dependencies should be documented in the relevant endpoint sections.
The PDF says this section should contain all APIs grouped under Enterprise Tools in the collection.

Callback Processes

Description

Using the callback processes below the platform can send information to the customer's Rest API using post method. The platform will check for HTTP responses from the API to flag if the call was successful (2XX) or not (3XX, 4XX, 5XX). However, it will not act according to the response, and it will not retry in case of a failure.

For the Callback Notification process, the notification will be marked as SENT if the API server responds with a failure code or no HTTP code is present in the response.

For the P2A SMS, the delivery report will be marked a success if the server responds with 2XX and as a failure for the rest of codes or no HTTP code is present in the response.

Notification Callback

Path: Enterprise Tools / Callback Processes / Notification Callback

Method: POST

URL: https://CustomerDefinedURL.com

Description

This Callback request is send to the customer defined URI.

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The accountID of the enterprise
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer

Input Notification Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction
callbackTimestamp	M	Timestamp of the callback (GMT timezone)
message	M	The customer configured notification message

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Callback Notification - Success — 200 — OK

No response body provided.

SIM Bulk Transfer Callback

Path: Enterprise Tools / Callback Processes / SIM Bulk Transfer Callback

Method: POST

URL: https://CustomerDefinedURL.com

Description

This Callback request is send to the customer defined URI.

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The Account id to who the SIM will be transfered.
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page. This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page. This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer

Input Bulk SIM Transfer Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction
callbackTimestamp	M	Timestamp of the callback (GMT timezone)
JobId	M	Unique ID generated for each sim transfer used to check the status of the transaction. <br> <br>This can be retrieved from Get Job status API.
successList	O	List of resources for which bulk request was successful. Resource appearing (ICCID/MSISDN/IMSI will depend on initial Bulk request.
failureList	O	Failure data with the reason

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

SIM Bulk Transfer Success — 200 — OK

No response body provided.

Data Stream Callback (UsageEvents)

Path: Enterprise Tools / Callback Processes / Data Stream Callback (UsageEvents)

Method: POST

URL: https://CustomerDefinedURL.com

Description

This Callback request with Usage Events is send to the customer defined URI. Note: only events with a valid (non-NULL) PLMN code will be processed and delivered as successful datastream usage callback APIs aligned with the GUI portal

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details
usageEvents	M	Object of the usageEvents details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The accountID of the enterprise
callbackURI	M	Callback URI defined by the customer
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackIndex	M	An autoincrement number. Unique per customer per date. resets that end of each UTC day
date	M	Date based on UTC

Input usageEvents Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction.
callbackTimestamp	M	Timestamp when the callback has happened (GMT timezone)
noOfRecords	M	Number of records of events
rows	M	UsageEvents details.

Rows

Field	Optional/ Mandatory	Description
generationTimeStamp	M	Datetime of the generated Event based on customer timezone.
callStartTimeUTC	M	The callStartTimeUTC is the start time of the data session based on UTC timezone
callStopTimeUTC	M	The callStopTimeUTC is the time of the last update (when quota was consumed or session ended/closed) based on UTC timezone.
callStartTime	M	Start datetime of the data session based on customer timezone.
callStopTime	M	The callStopTime is the time of the last update (when quota was consumed or session ended/closed) based on customer timezone.
aParty	M	MSISDN of the Endpoint
callCharge	M	Charge of the usage in 1/100th of the unit (cents in case of EURO)
locationInfo	M	Gives the location of the visited network (6 digit format) <br>Data: MCC/MNCof the visited network <br>SMS: MCC/MNC of the network where the SMS was originated
imsi	M	IMSI of the Endpoint
planId	M	Provides the Plan Id of the Endpoint
volumeAccumulated	M	Consumed Volume of the transaction
accessFlag	M	Indicates the type of service <br>2 - for Data <br>6 - for SMS <br>124 - NB-IOT
comments	M	Comments for this usage event
ratingGroup1	M	Rating Group Id, <br>2 – RG-OTA <br>3 – RG-Redirect <br>5 – RG-Online <br>Note: ratingGroup1 will be empty for SMS usage
tariffInfo	M	For Data usage this is the unique tariff Id along with zero appended ie "Tariffid-0". <br>For SMS usage this is the unique tariff Id along with PPU(price per unit) and Pulse ie "Tariffid-PPU-PULSE".
origCountry	M	Originating country ID <br>Use "Get Countries" API to retrieve the Country Id list.
iccid	M	ICCID of the Endpoint
imei	M	IMEI of the Device
bparty	M	bparty number
rateZoneId	M	Ratezone Id of the account
parentEntityName	M	Name of the customer in the platform
apn	M	APN used for the specific transaction
planStartDate	M	The start date of the addon Plan that was used.
planExpiryDate	M	The End date of the addon Plan that was used.
uniqueId	M	The unique id of the addon Plan that was used.
chargingId	M	The ID (unique) of the data session,. It remains constant for all transactions under the same session. <br>Can be used to identify all the transactions under one specific data session.
ccRequestNumber	M	The sequence number of the transaction within a data session. It is unique for the specific session. <br>Starts with 0 and its is autoincrement for each transacition.
ratType	M	Service Profile Access Type (RAT Type) <br>01 – 2G/3G <br>02 – 2G <br>06 - 2G/3G/4G <br>08 - NB-IoT
origOperatorPLMN	M	Tadig of the visited operator
accountId	M	Account Id of the Endpoint (Endpoint ID)
parentAccountId	M	Account ID of the immediate parent
supplierName	M	It describes which IMSI (Sponsor) was used by the endpoint when the event was generated
iPAddress	M	The IP address of the device

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Data Stream Callback(UsageEvents) - Success — 200 — OK

No response body provided.

Data Stream Callback (MobilityEvents)

Path: Enterprise Tools / Callback Processes / Data Stream Callback (MobilityEvents)

Method: POST

URL: https://CustomerDefinedURL.com

Description

This Callback request with Mobility Events is send to the customer defined URI.

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details
mobilityEvents	M	Object of the mobilityEvents details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The accountID of the enterprise
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer
callbackIndex	M	An autoincrement number. Unique per customer per date. resets that end of each UTC day
date	M	Date based in UTC

Input mobilityEvents Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction
callbackTimestamp	M	Timestamp of the callback (GMT timezone)
noOfRecords	M	Number of records of events
rows	M	MobilityEvents details

Rows

Field	Optional/ Mandatory	Description
country	M	Country name
endUserAccountId	M	EndpointID
serialNumber	M	Unique number for all MobilityEvents
endUserAccountName	M	Endpoint name
errorDescription	M	Description of the error. Available only in failure events
accountName	M	Account Name of the immediate parent customer
tadig	M	Tadig code of the operator <br>Tadig code will be empty for these events - Create PDP, Delete PDP, SMS-MO
errorCode	M	Error Code is available only in failure events <br>NOTE: For failure events the errorCode will be same as errorCause.
imsi	M	IMSI of the Endpoint
operatorName	M	Name of the operator
result	M	Status of the event
accountId	M	Account Id of the immediate parent customer
errorCause	M	Error code of the process <br>SUCCESS <br>2001 - Operation Success <br>1016 - Debit Success <br>3005 - Update Subscriber Success <br>FAILURE <br>4012 - Low Balance <br>4001 - Aparty authentication failure <br>1393 - UsageLimit Reached <br>5042 - Data Session Count Exceeded <br>1240 - Invalid IMEI <br>NOTE: For failure events the errorCode will be same as errorCause and for failure HSS events errorCause will be same as errorDescription
iccid	M	ICCID of the Endpoint
remoteNodeType	M	The Type of the Remote Node
msisdn	M	MSISDN of the Endpoint
imei	M	IMEI of the Device
timestampAccount	M	Timestamp of the Event in the Account time-zone
networkType	M	Network Type (Possible outcome 2G,2G/3G,2G/3G/4G,4G)
operation	M	Operation name
operatorId	M	Operator Id of the latched network
remoteNodeHost	M	The host of the Remote Node
timestamp	M	Timestamp of the Event in GMT timezone
remoteNodeGT	M	The GT of the Remote Node
remoteNodeRealm	M	The Realm of the Remote Node
supplierName	M	It describes which IMSI (Sponsor) was used by the endpoint when the event was generated
locationInfo	M	MCC/MNC in 6 digits

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Data Stream Callback (MobilityEvents) - Success — 200 — OK

No response body provided.

Data Stream Callback (MobilityEvents) - Failure

No response body provided.

Data Stream Callback (MobilityEvents) - Success — 200 — OK

No response body provided.

Data Stream Callback (Account Events)

Path: Enterprise Tools / Callback Processes / Data Stream Callback (Account Events)

Method: POST

URL: https://CustomerDefinedURL.com

Description

This Callback request is send to the customer defined URI.

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details
accountEvents	M	Object of the accountEvents details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The AccountId who is receiving the callback response
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page. This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page. This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer

Input accountEvents Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction
callbackTimestamp	M	Timestamp of the callback (GMT timezone)
noOfRrcords	M	Number of records of events
rows	M	Account Events details

Rows

Field	Optional/ Mandatory	Description
category	M	Field of the Account events
eventType	M	The type of eventbased on category
status	M	success or failure
timestamp	M	Timestamp of the Event in GMT timezone
accountName	M	Account name of the event initiator. It can be the endpoint name or the direct customer account name or in some cases the customer’s immediate parent account name.
timestampAccount	M	Timestamp of the Event in the Account time-zone
accountId	M	Account id of the event initiator. It can be the endpoint id or the direct customer account id or in some cases the customer’s immediate parent account id.
response	M	Status of the event described

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Data Stream Callback(Account Events) - Success — 200 — OK

No response body provided.

Data Stream Callback (Endpoint Events)

Path: Enterprise Tools / Callback Processes / Data Stream Callback (Endpoint Events)

Method: POST

URL: https://CustomerDefinedURL.com

Description

This Callback request is send to the customer defined URI.

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details
endpointEvents	M	Object of the endpointEvents details <br>

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The Account id to who the SIM will be transfered.
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page. This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page. This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer

Input endpointEvents Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction
callbackTimestamp	M	Timestamp of the callback (GMT timezone)
noOfRrcords	M	Number of records of events
rows	M	Endpoint Events details

Rows

Field	Optional/ Mandatory	Description
category	M	Field of the Endpoint events
eventType	M	The type of eventbased on category
endpointName	M	name of Endpoint
endpointId	M	Id of the Endpoint
description	M	Status of the event described
eventstatus	M	Status Id based on the event type
categoryId	M	Id of the category
timestamp	M	Timestamp of the Event in GMT timezone
msisdn	M	MSISDN of the endpoint
imsi	M	IMSI of the endpoint
result	M	success or failure
accountName	M	Account name of the immediate parent customer
iccid	M	ICCID of the endpoint
timestampAccount	M	Timestamp of the Event in the Account time-zone
accountId	M	Account Id of the immediate parent customer

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Data Stream Callback (Endpoint Events) - Success — 200 — OK

No response body provided.

P2A SMS (Callback API)

Path: Enterprise Tools / Callback Processes / P2A SMS (Callback API)

Method: POST

URL: https://CustomerDefinedURL.com

Description

P2A SMS (Callback API) is used to deliver, SMS send by endpoints towards application (platform), , to customers callback API

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
apiCallback	M	Object of the apiCallback details
p2aSMS	M	Object of the p2aSMS details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The accountId of the enterprise
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer

Input p2aSMS Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback id for that transaction
callbackTimestamp	M	Timestamp of the callback (GMT timezone).
msisdn	M	MSISDN of the originating endpoint
imsi	M	IMSI of the originating endpoint
endPointId	M	Endpoint Id of the originating endpoint
iccid	M	ICCID of the originating endpoint
destinationAddr	M	Short code address<br>Note that Short-Codes in the range between 10000 – 19999 are reserved and shall not be used as Destination Address from the Endpoint.
protocolId	M	This parameter specifies the protocol identifier as per TP‑Protocol‑Identifier in 3GPP Technical Specification 23.040 and encoded as hex-string.<br>Values allowed are,<br>00 - default<br>3F - GSM/UMTS mobile station<br>40 - Flash Message (dataCoding shall be defined accordingly to Class 1)<br>7C - ANSI-136 R-DATA (dataCoding shall be defined accordingly to Class 2) using the mechanism described in GSM TS 11.14 and 3GPP TS 31.102 <br>7E- Mobile Equipment Data download (dataCoding shall be normally set to Class 1) <br> 7F - (U)SIM Data (dataCoding shall be defined accordingly to Class 2) using the mechanism described in GSM TS 51.011 and 3GPP TS 31.102
dataCoding	M	This parameter defines the encoding scheme of the short message user data. It is defined as per 3GPP Technical Specification 23.038 and encoded as hex-string.<br>Examples,<br>0 = default (which is 7-bit GSM alphabet)<br>1 = 7-bit GSM alphabet<br>4 = 8-bit data<br>8 = UCS2 (16-bit)
udhi	M	User Data Header Indicator - this parameter defines whether shortMessage begins with User Data Header.
shortMessage	M	Up to 140 octets of short message user data encoded as hex-string.

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

P2A SMS (Callback API) - Success — 200 — OK

No response body provided.

A2P SMS Status (Callback API)

Path: Enterprise Tools / Callback Processes / A2P SMS Status (Callback API)

Method: POST

URL: https://CustomerDefinedURL.com

Description

A2P SMS Status (callback API) is used from customer to retrieve, in his callback API, the status/error Code of his A2P SMS.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

INPUT PARAMETERS

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The accountId of the Reseller/enterprise
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackURI	M	Callback URI defined by the customer
jobId	M	Job ID for that transaction which is used to retrieve the status of the A2P SMS by using Get job details API

INPUT RESULTPARAM PARAMETERS

Field	Optional / Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

INPUT RESPONSEPARAM PARAMETERS

Field	Optional/Mandatory	Description
resourceType	M	{"msisdn", "imsi", "endpointID", "iccid"}
value	M	Value of the field to be updated based on the resourceType used in request
sourceAddr	M	Address of Entity sending SMS. This value will be made available to the recipient of a message to see what the message’s originating address was.<br> Format is a numeric value from 1 to 9 digits.<br>Note that Short-Codes in the range 10000 – 19999 are reserved and shall not be used as sourceAddr
protocolid	M	This parameter specifies the protocol identifier. It is defined as per 3GPP Technical Specification 23.040 and encoded as decimal.<br>Values allowed are,<br>0 = default<br>63 = GSM/UMTS Mobile station<br>64 = Short Message Type 0 (Endpoint shall acknowledge receipt of the short message but shall discard its contents)<br>124 = ANSI-136 R-DATA(dataCoding shall be defined accordingly to Class 2) using the mechanism described in GSM TS 11.14 and 3GPP TS 31.102<br>126 = Mobile Equipment Data download (dataCoding shall be normally set to Class 1)<br>127 = (U)SIM Data (dataCoding shall be defined accordingly to Class 2) using the mechanism described in GSM TS 51.011 and 3GPP TS 31.102
dataCoding	M	This parameter defines the encoding scheme of the short message user data. It is defined as per 3GPP Technical Specification 23.038 and encoded as decimal<br>Examples,<br>0 = default (which is 7-bit GSM alphabet)<br>1 = 7-bit GSM alphabet<br>4 = 8-bit data<br>8 = UCS2 (16-bit)
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

A2P SMS (Callback API) - Success

No response body provided.

eSIM Profile Status Notifications

Path: Enterprise Tools / Callback Processes / eSIM Profile Status Notifications

Method: POST

URL: https://CustomerDefinedURL.com

Description

Whenever an action is performed by the LPA of the Consumer device on the eSIM Profile (Download, Install, Enable, Disable or Delete eSIM), SFT Platform shall notify via the callback notification request to the customer defined URI.

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
apiCallback	M	Object of the apiCallback details
eSimProfileStatusNotification	M	Object of the eSimProfileStatusNotification details

Input apiCallback Parameters

Field	Optional/ Mandatory	Description
accountId	M	The Id of Account which request is sent to
callbackURI	M	Callback URI defined by the customer
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also
callbackProcessName	M	The name of the callback process as it is visible in the callback framework page.This can be retrieved from CallBack API-GET also

Input eSimProfileStatusNotification Parameters

Field	Optional/ Mandatory	Description
callbackId	M	System generated callback ID for that transaction.
callbackTimestamp	M	Timestamp when the callback has happened (GMT timezone)
noOfRecords	M	Number of records of events
rows	M	eSimProfileStatusNotification details.

Rows

Field	Optional/ Mandatory	Description
eid	M	Identifies the targeted eUICC.
iccid	M	Identifies the ICCID of the eSIM Profile to which the Status Notification refers to.
simProductId	M	The ID SIM Product of the eSIM Profile.
eSimProfileType	M	Identifies the Profile Type associated with the eSIM Profile.
timestamp	M	Indicates the date and time when the operation to which the Status Notification refers to has been performed (GMT timezone)
timestampAccount	M	Indicates the date and time when the operation to which the Status Notification refers to has been performed (Account timezone)
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 <br> <br>Note: eSIM Profile Status of 'error' is generic and could be caused by different reasons as specified in 5.2.6.2 section of SGP.22. Few examples of Reason Codes are, <br>- Maximum number of retries exceeded <br>- Refused - End User Rejection <br>- Processing Error

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

eSIM Profile Status Notifications

No response body provided.

Update Monthly Limit (Postpaid)

Path: Enterprise Tools / Update Monthly Limit (Postpaid)

Method: POST

URL: https://sft.bics.com/api/updateMonthlyLimit

Description

This API is used to update monthly limit. In case of customer, update monthly limit is an asynchronous processs.

Account Access

Account Type	Access	Comments
Reseller	Yes
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 monthly limit details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
accountId	M	Endpoint Id or Customer Id
monthlyLimit	M	Monthly Limit
reason	M	Reason for update monthly limit

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
1394	Successful!! request has sent for processing!!

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "accountId":"51079021",
         "monthlyLimit":"UNLIMITED",
         "reason":"test"
      }
   }
}

Response Examples

Update Monthly Limit (Postpaid) - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "3006",
            "resultDescription": "Update endpoint/customer failure"
        }
    }
}

Update Monthly Limit (Postpaid) - Success - {Customer} — 200 — OK

JSON

{
    "Response": {
        "responseId": "39149964308098400",
        "responseTimestamp": "11/05/2020 04:50:14",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "1394",
            "resultDescription": "Successful!! request has sent for processing!!"
        }
    }
}

Update Monthly Limit (Postpaid) - Success - {Endpoint} — 200 — OK

JSON

{
    "Response": {
        "responseId": "39150440522677643",
        "responseTimestamp": "11/05/2020 04:58:10",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "3005",
            "resultDescription": "Update endpoint/customer success"
        }
    }
}

Update Balance (Prepaid)

Path: Enterprise Tools / Update Balance (Prepaid)

Method: POST

URL: https://sft.bics.com/api/updateBalance

Description

This API is used to update prepaid balance. It can be credit or debit. In case of customer, update balance is asynchronous processs.

Account Access

Account Type	Access	Comments
Reseller	Yes
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 monthly limit details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
accountId	M	Endpoint Id or Customer Id
action	O	Action to be performed against balance. Available actions are <br> <br>Set: to set the balance to the amount defined in the amount parameter <br> <br>Reset: to set balance to 0 even if the amount is given or not given <br> <br>Topup: to add the amount to the already existing balance <br> <br>Deduct: to remove the amount from the specific balance. If the amount deducted is bigger than current balance then it entity balance will become negative and might risk services <br> <br>NOTE: If the action parameter is omitted, the balance will be adjusted based on its value — positive values increase the balance, while negative values decrease it. <br> <br>Values given inside action are case insensitive
balance	M	Balance to be credited or debited
reason	M	Reason for update balance

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
1394	Successful!! request has sent for processing!!

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "accountId":"51060308",
         "balance":"+100",
         "reason":"XXX"
      }
   }
}

Response Examples

Update Balance (Prepaid) - Success - {Balance Credited} — 200 — OK

JSON

{
    "Response": {
        "responseId": "39150674728228834",
        "responseTimestamp": "11/05/2020 05:02:04",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "3005",
            "resultDescription": "Update endpoint/customer success"
        }
    }
}

Update Balance (Prepaid) - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "3006",
            "resultDescription": "Update endpoint/customer failure"
        }
    }
}

Update Balance (Prepaid) - Success - {Balance Debited} — 200 — OK

JSON

{
    "Response": {
        "responseId": "39150762267354884",
        "responseTimestamp": "11/05/2020 05:03:32",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "3005",
            "resultDescription": "Update endpoint/customer success"
        }
    }
}

Update Balance (Prepaid) - Success - {Balance Reset}

JSON

{  
   "Response":{  
      "responseId":"92157820093497",
      "responseTimestamp":"20/10/2020 18:05:04",
      "resultCode":"0",
      "resultParam":{  
         "resultCode":"3005",
         "resultDescription":"Update endpoint/customer success"
      }
   }
}

Bulk Update Balance (Prepaid)

Path: Enterprise Tools / Bulk Update Balance (Prepaid)

Method: POST

URL: https://sft.bics.com/api/bulkUpdateBalance

Description

This API is used to update prepaid balance for multiple accounts or multiple endpoints.

Multiple actions against balance are supported (Set, Reset, Deduct, TopUp)

Maximum number of accounts/endpoints that can be updated is 4000.

This API is

synchronous when a single endpoint is updated
Asynchronous when multiple endpoints are updated
Asynchronous when updating the balance of an account (single or multiple)

When API is acting in Asynchronous mode, user can get the final result by calling the “Get bulk Job details” API using the JobID provided in the responce of this API.

EndFragment

Account Access

Account Type	Access	Comments
Reseller	Yes
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 monthly limit details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
resourceType	M	Used for defining the type of information that will be provided under the parameter "valuelist" <br>Possible values: <br> <br>accountId <br> <br>endpointId <br> <br>imsi <br> <br>iccid <br> <br>msisdn <br> <br>Values given inside resourcetype are case insensitive
valueList	CM	List of resourceType (Max4000) <br> <br>Note: Mandatory if valueRange is not available
action	M	Action to be performed against balance. Available actions are <br> <br>Set: to set the balance to the amount defined in the amount parameter <br> <br>Reset: to set balance to 0 even if the amount is given or not given <br> <br>Topup: to add the amount to the already existing balance <br> <br>Deduct: to remove the amount from the specific balance. If the amount deducted is bigger than current balance then it entity balance will become negative and might risk services <br> <br>Values given inside action are case insensitive
balance	CM	balance <br>Mandatory if action is <br>Set <br>Deduct <br>TopUp <br>NOTE: If amount is provided with action Reset, it is simply ignored and balance is set to 0
reason	M	User Comment

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
JobId	M	Unique ID generated for each bulk modification. Used as input in the “Get bulk Job details” API. 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
1001	Wrong input parameter –{Parameter Name}
10073	Maximum count exceeds for input Parameter - {reason}
1000	Mandatory parameter missing –{Parameter Name}
1889	Parameter length is not in range-{Parameter Name}
401	User Authorization failed
2503	Subscriber not in active state
10209	Not a Prepaid customer/Endpoint
10205	Bulk update balance success
10206	Bulk update balance failure
10207	Success!! Request has sent for processing
10216	Duplicate Value in Request
2028	Operation not allowed
5030	Subscriber does not exists

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
        "resourceType":"endpointid",
        "valueList": ["51949959","51949958"],
        "action":"topup",
        "balance":"50",
        "reason":"XXX"
     }
   }
}

Response Examples

Bulk Update Balance (Prepaid) - Success - {Balance Topup} — 200 — OK

JSON

{
    "Response": {
        "responseId": "6699934597633264",
        "responseTimestamp": "22/06/2023 05:13:59",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10207",
            "resultDescription": "Success!! Request has sent for processing"
        },
        "JobId": "6469"
    }
}

Bulk Update Balance (Prepaid) - Failure

JSON

{
    "Response": {
        "responseId": "6797723851645918",
        "responseTimestamp": "23/06/2023 08:23:48",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "10206",
            "resultDescription": "Bulk Update Balance failure"
        }
    }
}

Bulk Update Balance (Prepaid) - Success - {Balance Deduct} — 200 — OK

JSON

{
    "Response": {
        "responseId": "6713885430844254",
        "responseTimestamp": "22/06/2023 09:06:30",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10207",
            "resultDescription": "Success!! Request has sent for processing"
        },
        "JobId": "6471"
    }
}

Bulk Update Balance (Prepaid) - Success - {Balance Reset}

JSON

{
    "Response": {
        "responseId": "6699934597633264",
        "responseTimestamp": "22/06/2023 05:13:59",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10207",
            "resultDescription": "Success!! Request has sent for processing"
        },
        "JobId": "6469"
    }
}

Bulk Update Balance (Prepaid) - Success - {Balance Set}

JSON

{
    "Response": {
        "responseId": "6699934597633264",
        "responseTimestamp": "22/06/2023 05:13:59",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10207",
            "resultDescription": "Success!! Request has sent for processing"
        },
        "JobId": "6469"
    }
}

SMS - Send to Endpoint

Path: Enterprise Tools / SMS - Send to Endpoint

Method: POST

URL: https://sft.bics.com/api/sendSMS

Description

Send SMS API will be used to Sending SMS.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
sendSMSInfo	M	Object of the sendSMSInfo

Input sendSMSInfo Parameters

Field	Optional/Mandatory	Description
messageType	M	Message Type (1 -text)
msisdn	M	MSISDN
message	M	Message, Max allowed length is 80 <br>Special characters are allowed. For double quote(") and back slash(\) characters need to explicitly add escape character(\).

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
10023	Send SMS success
10024	Send SMS failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "sendSMSInfo":{  
      "messageType":"1",
      "msisdn":"32770000000005",
      "message":"test postman"
   }
}

Response Examples

SMS - Send to Endpoint - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10023",
            "resultDescription": "Send SMS success"
        },
        "resultCode": "0",
        "responseId": "1589214874372",
        "responseTimestamp": "11/05/2020 16:34:34"
    }
}

SMS - Send to Endpoint - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10024",
            "resultDescription": "Send SMS failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

SMS - A2P SMS

Path: Enterprise Tools / SMS - A2P SMS

Method: POST

URL: https://sft.bics.com/api/a2pSMS

Description

A2P SMS API shall be used to send A2P SMS to Endpoint.

Account Access

Account Type	Access	Comments
Reseller	No
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
a2pSMS	M	Object of the a2pSMS details

Input a2pSMS Parameters

Field	Optional/Mandatory	Description
resourceType	M	Input resource can be msisdn/imsi/endPointId/iccid
value	M	Value of resourceType
sourceAddr	M	Address of Entity sending SMS. This value will be made available to the recipient of a message to see what the message’s originating address was. <br>Format is a numeric value from 1 to 9 digits. <br>Note that Short-Codes in the range 10000 – 19999 are reserved and shall not be used as sourceAddr.
protocolId	O	This parameter specifies the protocol identifier. It is defined as per 3GPP Technical Specification 23.040 and encoded as decimal. <br>Values allowed are, <br>0 = default <br>63 = GSM/UMTS Mobile station <br>64 = Short Message Type 0 (Endpoint shall acknowledge receipt of the short message but shall discard its contents) <br>124 = ANSI-136 R-DATA(dataCoding shall be defined accordingly to Class 2) using the mechanism described in GSM TS 11.14 and 3GPP TS 31.102 <br>126 = Mobile Equipment Data download (dataCoding shall be normally set to Class 1) <br>127 = (U)SIM Data (dataCoding shall be defined accordingly to Class 2) using the mechanism described in GSM TS 51.011 and 3GPP TS 31.102
dataCoding	O	This parameter defines the encoding scheme of the short message user data. It is defined as per 3GPP Technical Specification 23.038 and encoded as decimal <br>Examples, <br>0 = default (which is 7-bit GSM alphabet) <br>1 = 7-bit GSM alphabet <br>4 = 8-bit data <br>8 = UCS2 (16-bit)
udh	O	This parameter defines the GSM User Data Header as specified in 3GPP Technical Specification 23.040 and encoded as hex-string. <br>In case udh is defined, SMSC shall concatenate udh and shortMessage and transparently forward the message downstream if length of udh and shortMessage is maximum 140 octets, otherwise request shall be rejected. <br>In case udh parameter is not defined and shortMessage length is higher than 140 octets, SMSC shall split into 140-octets segments and send message downstream by means of User Data Header which is implicitly generated by SMSC. <br>For more details on the usage of udh refer to wikipedia
shortMessage	M	Up to 1000 octets of short message user data encoded as hex-string if udh is not defined, otherwise the limit is 134 octets.

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
JobId	O	Unique ID generated for each A2P SMS Submitted. To be 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
10082	Submit A2P SMS success
10083	Submit A2P SMS failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

a2pSMS - Success — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10082",
            "resultDescription": "Submit A2P SMS success"
        },
        "resultCode": "0",
        "responseId": "1599846300178",
        "responseTimestamp": "11/09/2020 17:45:00",
        "JobId": "1449"
    }
}

a2pSMS - Failure — 200

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10083",
            "resultDescription": "Submit A2P SMS failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "11/09/2020 18:12:27"
    }
}

a2pSMS Long message :1st segment of message with ID “0a” sending text “This is the first segment of the long message.” — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10082",
            "resultDescription": "Submit A2P SMS success"
        },
        "resultCode": "0",
        "responseId": "1601566618482",
        "responseTimestamp": "01/10/2020 15:36:58",
        "JobId": "1907"
    }
}

a2p SMS :Flash Message using UCS2 (16-bit) alphabet — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10082",
            "resultDescription": "Submit A2P SMS success"
        },
        "resultCode": "0",
        "responseId": "1601567345838",
        "responseTimestamp": "01/10/2020 15:49:05",
        "JobId": "1910"
    }
}

a2pSMS long Message:2nd segment of message with ID “0a” sending text “This is the second segment of the long message.” — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10082",
            "resultDescription": "Submit A2P SMS success"
        },
        "resultCode": "0",
        "responseId": "1601566626995",
        "responseTimestamp": "01/10/2020 15:37:07",
        "JobId": "1908"
    }
}

SIM - Cancel Location

Path: Enterprise Tools / SIM - Cancel Location

Method: POST

URL: https://sft.bics.com/api/cancelLocation

Description

The Cancel subscriber location feature is used to trigger HSS Cancel Location procedures for a given (single) IMSI, for all the network domains (2G, 3G, 4G, NBIOT) where the subscriber is currently attached. This method is synchronous: the API will wait for all the CL procedures to finish before responding back.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
cancelLocationInfo	M	Object of the Cancel Location info

Input destinationGroupinfo Parameters

Field	Optional/Mandatory	Description
resourceType	M	This is resource type which can be IMSI,ICCID,MSISDN or endPointId
value	M	Value of resource type

Output

Output 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
10046	Cancel location success
10047	Cancel location failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{
  "cancelLocationInfo": {
    "resourceType": "IMSI",
    "value": "206281000000000"
  }
}

Response Examples

SIM - Cancel Location - Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10047",
            "resultDescription": "Cancel location failure"
        },
        "resultCode": "1",
        "responseId": "1589307147698",
        "responseTimestamp": "12/05/2020 18:12:27"
    }
}

SIM - Cancel Location - Success - {IMSI} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10046",
            "resultDescription": "Cancel location success"
        },
        "resultCode": "0",
        "responseId": "1589215517114",
        "responseTimestamp": "11/05/2020 16:45:17"
    }
}

SIM - Cancel Location - Failure - {Invalid MSISN} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "1001",
            "resultDescription": "Wrong input parameter -MSISDN"
        },
        "resultCode": "1",
        "responseId": "1589215400558",
        "responseTimestamp": "11/05/2020 16:43:20"
    }
}

SIM - Cancel Location - Success - {MSISDN} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10046",
            "resultDescription": "Cancel location success"
        },
        "resultCode": "0",
        "responseId": "1589215329519",
        "responseTimestamp": "11/05/2020 16:42:12"
    }
}

SIM - Cancel Location - Success - {ICCID} — 200 — OK

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10046",
            "resultDescription": "Cancel location success"
        },
        "resultCode": "0",
        "responseId": "1589215433397",
        "responseTimestamp": "11/05/2020 16:43:53"
    }
}

CallBack Modify

Path: Enterprise Tools / CallBack Modify

Method: PATCH

URL: https://sft.bics.com/api/modifyCallback

Description

This API is used to define or modify information for callback APIs. It can be used to change the Token and/or the callback URI of a callback process. Only one URI can be defined/modified at a time. Use "" for "callbackURI" to remove existing value.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input Parameters

Field	Optional/Mandatory	Description
callbackToken	O	X-Authorization header token of the corresponding end user. <br>
callbackProcessList	O	Available callback process list for the account id.Callback API – JWT Token structural validation process <br> <br>Step 1 : Check the number of dots(.) Should be exactly two. <br>Step 2: Split the string by using dot(.) to validate header and payload and signature should be base 64 <br>First part is HEADER:ALGORITHM & TOKEN TYPE <br>Second part is PAYLOAD:DATA <br>Third part is VERIFY SIGNATURE <br>Step 3: Base 64 encryption validation, platform would be validated string should be Base 64 encoded <br> <br> <br>Ex. <br> <br>eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzdXBlcmFkbWluIiwiYXVkIjoiQUNDRVNTIiwic2NvcGVzIjoiQURNSU4iLCJpc3MiOiIxMDAwMDAiLCJpYXQiOjE2NzA1NzE5MzcsImV4cCI6MTY3MDU4NjMzN30.d_F_qSEWoDjgHMsuFvX3roExy4rr8REzTphrWqatIZOLtICn9y1eaeSgQ2QC2b0GpFUP7E338s6bv6OPE34tow <br> <br> <br>

Input CallbackProcessList Parameters

Field	Optional/Mandatory	Description
callbackProcessId	M	The id of the callback process as it is visible in the callback framework page.This can be retrieved using CallBack Information API
callbackURI	M	Callback URI defined by the customer

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

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
10095	Update callback profile success
10096	Update callback profile failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{
	"callbackprofile": {
		"callbackToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzdXBlcmFkbWluIiwic2NvcGVzIjoiQURNSU4iLCJpc3MiOiJodHRwOi8vbXZuZS5jb20iLCJpYXQiOjE1MDI4NjYxNDUsImV4cCI6MTUwMjkyNjE0NX0.d--eNsY8-GWFFvblKOXo69hy2u4sUgeiMIhen-h5xsGngLsw-zLY2OB5_acm59MTjvaQq_EX7cT2ZX3oYU87aw",
		"CallbackProcessList": {
			"callbackProcessId": "10001",
			"callbackUri": "CustomerDefinedURL.com"
		}
	}

}

Response Examples

CallBack Modify - Success

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "10095",
            "resultDescription": "Update callback profile success"
        },
        "resultCode": "0",
        "responseId": "1604583369762",
        "responseTimestamp": "05/11/2020 19:06:10"
    }
}

CallBack URI Modify-Failure

JSON

{
    "Response": {
        "resultParam": {
            "resultCode": "1000",
            "resultDescription": "Mandatory parameter missing -callbackProcessId"
        },
        "resultCode": "1",
        "responseId": "1605684909260",
        "responseTimestamp": "18/11/2020 13:05:09"
    }
}

CallBack Information

Path: Enterprise Tools / CallBack Information

Method: GET

URL: https://sft.bics.com/api/callback

Description

This API is used to fetch all callback API configuration of a particular customer.

Account Access

Account Type	Access	Comments
Reseller	Yes
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 the result, contains result code and description
responseParam	O	Callback API details will be available here.

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Output responseParam Parameters

Field	Optional/Mandatory	Description
callbackToken	O	X-Authorization header token of the curresponsing end user.
callbackProcessList	O	A list contains all available call back process list for the account id would be there.

Output CallbackProcessList Parameters

Field	Optional/Mandatory	Description
callbackProcessId	M	callback process id
callbackProcessName	M	Callback process name
callbackURI	O	Callback URI

Result Codes

Result Codes	Description	Next Steps
10092	Get callback profile success
11005	Get callback profile failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

CallBack API - Success

JSON

{
	"Response": {
		"resultParam": {
			"resultCode": "10092",
			"resultDescription": "Get callback profile success"
		},
		"resultCode": "0",
		"responseParam": {
			"rows": [{
				"callbackToken": "DI4NjYxNDUsImV4cCI6MTUwMjkyNjE0NX0.xsGngLsw-zLY2OB5_acm59MTjvaQq_EX7cT2ZX3oYU87se",
				"callbackProcessList": [{
					"callbackProcessId": "10015",
					"callbackProcessName": "A2P-SMS Status",
					"callbackURI": "https://CustomerDefinedURI.com"
				}, {
					"callbackProcessId": "10011",
					"callbackProcessName": "CallBackNotification",
					"callbackURI": "https://CustomerDefinedURI.com"
				}, {
					"callbackProcessId": "10010",
					"callbackProcessName": "P2A SMS",
					"callbackURI": "-"
				}, {
					"callbackProcessId": "10012",
					"callbackProcessName": "Usage Events (Bulk)",
					"callbackURI": "-"
				}, {
					"callbackProcessId": "10013",
					"callbackProcessName": "Mobility Events (Bulk)",
					"callbackURI": "https://CustomerDefinedURI.com"
				},{
					"callbackProcessId": "10019",
					"callbackProcessName": "eSIM Profile Status Notifications",
					"callbackURI": "https://CustomerDefinedURI.com"
				}
                ]
			}]
		},
		"responseId": "17529755580322428",
		"responseTimestamp": "04/06/2021 11:20:46"
	}
}