.jpg)
21. Release Notes
21. Release Notes
New Release Versioning Scheme
Starting from the first release of 2026, we will adopt a new version numbering format.
Instead of using the format 4.XX, releases will now follow a Year.Release Number structure.
For example, the first release of 2026 will be numbered 26.1, the second 26.2, and so on.
Please note that all previous release notes (under the 4.XX format) have been moved to a separate folder named "Legacy Releases" for reference.
26.1 - February 25, 2026
Post Plan – Delete (New Version)
A new version of the "Post Plan – Delete" API is now available. This new version is more efficient and consumes fewer resources. It has been published under a new URL:
/api/DeleteRatePlanThis is different from the existing "Post Plan – Delete" API, which uses:/api/DeletePlanCurrently, both versions are operational. However, customers are strongly encouraged to start using the new version since the old onewill be deprecated and discontinued in the next release.
Post Plan – Delete (Old version)
The old version will be deprecated and discontinued in the next release 26.2
POST Pan - Modify
A new parameter, notificationId, has been added under the Input Notification parameters. This parameter can be used to modify an existing configured plan notification. The notificationId can be retrieved via the "Get Query Rate Plan" API. If a customer wants to modify an existing notification (for example, to change the message), they must provide the notificationId to specify which notification should be updated. If the customer wants to add a new notification to the plan, the notificationId can be omitted and the remaining parameters can be used as they are today.
POST Tariff - Modify Price
The API URL provided in the documentation was incorrect and has now been corrected. Previously, the documentation listed the API URL as:
/api/ModifyPriceTariffThe correct API URL is:/api/ModifyTariffPriceThis is a documentation correction only.
GET GetEndpointAddonDetails
The documentation for the output parameters "Info" and "Counter" has been corrected. Previously, they were shown with an uppercase first letter, while in the actual API response the first letter is lowercase. There are no changes to the API itself — this is only a documentation fix.
Legacy Releases
This subsection contains related API documentation.
4.20.0 - December 8, 2025
POST SubscribeAddon - Balance Adjustment for Addon Plans
Benefit Control at Subscription Time
We added the possibility to adapt the benefit balance of the addon plan via the SubscribeAddon API.
Key Capabilities:
Flexible Balance Control: Adjust available units of addon plan benefits at subscription time
Partial Provisioning: Provision addons with custom starting balances for trial periods or promotional offers.
Auto-Reset on Renewal: Benefits automatically reset to full plan value upon renewal.
For more information refer to the documentation of the api "POST SubscribeAddon" under Endpoint section and the cooresponsive examples (3 examples for Adjusted Balance)
Plan Create & Plan Modify
New value for the parameter "validityType", under "Output Validity Parameters validityType=4 for End of the Month for Prepaid Added new result codes 80009 & 1257 - Also added n the Result Codes section
Get SIM
A new optional output parameter, "imei" has been added under the "Output SIM Parameters" section. Updated Examples: Fetch SIM - Success - {All}, Fetch SIM - Success - Example 6, Fetch SIM - Success - {Specific ICCID}
4.19.0 - September 25, 2025
New APIs
GET EndpointAddonDetails - NEW API!!
Introduced a new API to fetch Endpoint Addon details. Designed as a lighter and faster alternative to the GET EndpointProfile API. Returns only the mandatory information for an Endpoint Addon. Recommended to use this API instead of GET EndpointProfile when only addon details are required. Available under the Endpoint section.
Enhancements
POST Data Stream Callback UsageEvents & MobilityEvents
Added new input fields under apiCallback Parameters: - callbackIndex: Auto-numbers the API callbacks. Customers can use it to track received -callbacks and identify any missing ones. - date: Specifies the date in YYYYMMDD (UTC) format. Updated examples available under: - POST Data Stream Callback (UsageEvents) - POST Data Stream Callback (MobilityEvents) See Enterprise Tools ⇒ Callback Process for details.
GET SIM
Added a new output parameter: rspState (under Output SIM Parameters). Updated examples: - Fetch-SIM-success-eid - Fetch SIM - Success - Example 6 Refer to GET SIM in Enterprise Info.
GET Endpoints
Added new output parameter: eid (under Output Endpoint Parameters). Updated example: - Get EndPoints - Success Refer to GET Endpoints in Endpoint.
GET Endpoint - Profile
Added new output parameter: rspState. Updated descriptions for existing basicInfo output parameters. Updated example: - Get Endpoint Profile - Success {Example 1} Refer to GET Endpoint - Profile in Endpoint.
GET Endpoint - Geolocation
Added new Result Code details. Refer to GET Endpoint - Geolocation in Endpoint.
POST Endpoint - De-Link SIM
Added new Result Code details. Refer to POST Endpoint - De-Link SIM in Endpoint.
POST Endpoint - Threshold
Added new Result Code details. Refer to POST Endpoint - Threshold in Endpoint.
GET fetchNetworkStatus
Added a new example for the fetchNetworkStatus API. Refer to GET fetchNetworkStatus in Endpoint.
POST SMS - A2P SMS
Corrected the description for the shortMessage parameter. Refer to POST SMS - A2P SMS in Enterprise Tools.
Result Codes
As part of release 4.19.0, new Result Code details were added across multiple APIs.
4.18.0 - June 11, 2025
Post SubscribeAddon - New API!
A new API is now available for assigning Addon plans to endpoints. It is designed for assigning a single Addon at a time and returns the unique Addon ID in the response, simplifying integration and reducing the number of API calls needed to retrieve Addon details. You can find this API under the "Endpoint" section.
GET SIM
New query parameter "containsSponsor" that can be used to filter SIMs based on their sponsors IMSIs. Updated examples and new result codes available. For more info see "GET SIM" under "Enteprise Info"
GET Notification
Support has been added for the new notification type "Activation of Addon". For more details about this notification type, please refer to the 4.18.0 Release Notes. Examples have also been updated accordinly.
4.16.2 - February 12, 2025
New API rate-limiting
New API rate-limiting mechanism is implemented to ensure platform stability and better resource utilisation while reducing rate limit exceed waiting time for customers. More information in the "API Rate Limit" section
Responce Time & Timeout
Clarifications on API responce times and configured timeouts. Please refer to "Responce Time & API Timeout" section for more information.
Endpoint Modify & Endpoint Bulk Modfiy
Clarifications on number of addon that can be provisioned per API call and the maximum number of subscribed addons per endpoint. See "addAddonPlanIds" parameter under "Input requestParam Parameters" section.
4.17.0 - April 3, 2025
Get Destination Group & Get Roaming Profile
A new output parameter, "supplierPriority," has been added under the "Output TadigList Parameters" section. It is used to define the priority of a given network and is applicable only to customers using NextGenSIM. It has no function for customers without it. A relevant example is included.
Fetch SIM
A new output parameter, "eSimProfileStatus," has been added under the "Output SIM Parameters" section. This parameter indicates the current step reached in the eSIM Profile Download and Installation process. A relevant example is included.
Get EndpointProfile
A new output parameter, "eSimProfileStatus," has been added under the "Output basicInfo Parameters" section. This parameter indicates the current step reached in the eSIM Profile Download and Installation process. A relevant example is included.
Access Token
The response packet for the Access Token - Support User (Failure) example has been updated. The "resultCode" and "resultDescription" fields are now correctly included in the "resultParam" array, replacing the previous incorrect placement in "requestParam."
New SIM Products
New SIM product "Consumer eUICC Profile Dual IMSI IR2 White", id: 13825
4.16 - January 24, 2025
Addon Counter Functionality
With the current release, Addon plans support counters, similar with base plan. Parameters remains the same as for Base plan counters and support has been added to: - - Create Plan - Modify Plan - Qurey Rate Plan - Endpoint Profile For all above, updated examples have been added.
In addition, "Update threshold" API under Endpoint sections has been updated with additional Input requestParam Parameters - PlanId -counterId - UniqueID See above APIs for updated desciptions and use case examples
Modify Tariff Price - New API !
New, ligthweigh, API for modifying explicity Tarrif's price per unit. available under Tariff Section with examples
GET Account Users - New API !
New API to fetch the user under your accounts or under specific account in your hieararchy. Available under Organisation section with examples
Endpoint - Modify & Endpoint - Bulk Modify
New Input requestParam Parameters, "apnGroupId". Used to modify endpoint(s) APN Group. Available group ids can be fetch fetchApnGroup" API. See update example.
Access Token
New Results code available (11044) to when account is being blocked. Added also under Result Codes section
POST - CreateCustomUser
New result code "11043 : User CreationLimit Reached." added for API CreateCustomUser, under Organisation section, to identify specific error. Added also under th resle codes section.
4.15 - October 8, 2024
POST Plan - Create & POST Plan - Modify
Update the documenation for the "action" parameter under "Input usageCounter Parameters". Provide a detail list of "action" values and their usage
GET Customer Profile
New parameter "suspensionDate" under "Output basicInfo Parameters", provides date and time for the suspended accounts
Post Organisation - Create
New result code "10234" for the use case when "Child reseller creation is not possible|"
4.14 - July 24, 2024
POST createCustomUser
New API available to for account administrators to create and assign new users under their account. You can find more information together with examples and error codes in the documentation which is located under "Organisation" folder.
GET SIM
New query parameter "matchesSponsor" is avaialble to filter SIMs based on their sponsor. Check updated documentation for more information and examples on how to be used
POST Data Stream Callback (UsageEvents)
New parameters available under "Row" - planStartDate - planExpiryDate - uniqueId - chargingId - ccRequestNumber See documentation for more information (avail;able under "Enterprise Tools" ==> "Callback Processes" folder
GET Customer Profile
Added new parameter "customerType" under "Output basicInfo Parameters".
GET Endpoint Coverage
Added new parameter "supplierPriority" under "Output coverage Parameters ".
4.12.1 - February 23, 2024
GET - Customer Balance Infro
New API "Get Customer Balance Info" under "Organisation" section. Can be used to fetch Customer Balance from the platform.
4.13 - May 7, 2024
GET PLAN - PLAN Create - PLAN Modify
Multiple changes to support new Addon functionalities New parameters - Input Subscription Parameters - Input Validity Parameters Changes on the Input charge Parameters - chargeId": This is Removed. API will fail if it is provided - factor: This is Removed. Will be ignored if it is provided - frequency: This is Removed. Will be ignored if it is provided - autoRenewal: This is Removed. Will be ignored if it is provided Changes on the Input benefit Parameters - action: This is Removed. Will be ignored if it is provided Update examples to match the new addon parameters New result code for PLAN Modify - Added Result code 10277: "ModifyPlan not possible as subscription OR validity unlimited"
You can read more for the new addon functionalities on the documentation release notes: https://docs.sft.bics.com/sft/addon-plan-api-with-validity-and-subscription
Devie IP Address is now available in the UsageEvents Callback DataStream
New parameter unde Rows: "iPAddress" containing device IP address
GET Customer Profile
Added "Counter" parameter under "Output info Parameters". This is a documentation change only. The parameter was available via API but it was missed in the documenation
Endpoint Modify & Endpoint Bulk Modify
Now can be used to Bar/unBar services. New Input requestParam Parameters: bar_2G, bar_2G/3G, bar_4G, bar_5G, bar_SMS_MT, bar_SMS_MO, bar_DATA, bar_NB_IOT & bar_All_Services Updated examples and new error codes for new scenarios
4.12.0 - January 25, 2024
POST - Plan Create, POST - Plan Modify, GET - Query Rate Plan
Update examples for new SIM Management charge details.
GET - Charge
Update examples for new SIM Management charge details.
GET - Invoice
New parameters - localSimProfileDownloadFee - localSimHostingFee - localSimManagementFee under Output billingDetails Parameters
GET - SIM
New Parameter "smDpPlusProfileType" under Output SIM Parameters
GET - SIM
Correcting type for parameter "page" (instead of wrong "Page") under Query Parameters New Parameter "smDpPlusProfileType" under Output SIM Parameters
POST - eSIM Profile Status Notifications (under Callback Processes)
New callback api "eSIM Profile Status Notifications" available via GUI to be configured. Description of available parameters and example under "POST - eSIM Profile Status Notifications" under Callback Processes
GET - Callback Information
Update example for the new callback process - "eSIM Profile Status Notifications"
4.11.0 - October 19, 2023
POST Assign Plans to Account
Input requestParam Parameters "testplanId" was remaned to "testPlanId" for parameter naming consistency
GET SIM (fetchSIM)
New query parameter "eid" New parameter under Output SIM Parameters, "eid" New examples
POST - Data Stream Callback (Account Events)
Update the desciption of Input apiCallback parameter "accountId". It refers to the account who is receiving the callback response
Updated the example "Data Stream Callback(Account Events) - Success " by adding OEM SIM Activation charge event
GET Charge
Updated the example "GET Charge success" response by adding the SFT-OEM SIM Activation charge details
GET Invoice
New parameter "oemSimActivationFee" under Output billingDetails Parameters
Plan Create, Modify & Query Rate Plan
Updated the existing create plan, modify plan API request examples and QueryRatePlan response by adding OEM SIM Activation fee configuration entiers (see success examples for charge 24) Example { "chargeId": "24", "chargeAmount": "10", "actionType": "0" }
4.10.0 - August 10, 2023
POST Bulk Update Balance (Prepaid) - NEW API!!
EndFragment> New API for bulk updating balance of prepaiid accounts and endpoints. You can find the description and examples under "Enterprise Tools" section Result example is also available under the "GET Job Status"
GET fetchNetworkStatus - NEW API!!.
New API available to fetch the connectivity status of a given endpoint You can find the description and examples under "Endpoint" section
POST Assign APN to Account - NEW API!!.
New API available to assign APNs and default APN to an account
POST Assign Plans to Account - NEW API!!.
New API available to assign Base Plan to an account For OEM account it can be used to assign Test and Inventory plans
POST Assign Users to Account - NEW API!!.
New API available to assign default user to an account
Create Account via API
Using existing API 1. POST Organization - Create together with new APIs 2. POST Assign APN (This one) 3. POST Assign Plans to Account 4. POST Assign Users to Account (in this order) user can complete and automate the account creation process via APIs
POST- Create Endpoint
New result code "10221" - "Duplicate addon plans are not allowed"
Get Entpoints
New parameter tagIdList under "Output endpoints Parameters"
TAG Create
New result code 10120 added: "Maximum number of tag is reached"
TAG Modify
New result code 10120 added: "Maximum number of tag is reached"
POST - Data Stream Callback (Usage Events)
Parameter "locationInfo" now available for SMS usage events displaying the MCC/MNC of the network where the SMS was originated
POST - Data Stream Callback (Mobility Events)
New parameter ""locationInfo" under "Rows" New failure example
POST - Data Stream Callback (Account Events)
Updating the description of paramters "accountName" & "accountId" under "Rows" to clarify they refer to immediate parent
GET- Query Rate Plan API
New parameters "addOnPriority" and "activatedBy" under "Output basicInfo Parameters"
POST Roaming Profile - Delete
Result code "10130" not available anymore
POST- Plan create & Post-Modify Plan
New Message supported Identifiers available:
0 MSISDN of the SIM,Available in enterprise once sim is activared
47 IMSI 0f the sim,Available in enterprise once sim is linked to endpoint
57 ICCID of the sim, available in enterprise once the sim is linked to endpoint
4.9.0 - May 25, 2023
Access Token
Result code 10141 replaced by result code 10126: "API operation has Time out. Request has been received and is has timeout before we receive the response. Please verify the request has been completed successfully or not. using the appropriate APIs."
Plan -Create
New result code 10183: "Dynamic Benefits is not allowed for Addon plan"
Query Rate Plan
New parameter "dynamicBenefitsDetails" under Output plan Parameterssection
Updated the examples for OEM for Test plan example (benefitName)
Bulk SIM Transfer
Added new result code 10142: "SIM Transfer failure - Start range or end range is not valid"
Job Status
Added new section "Output responseParam Parameters for Bulk SIM Transfer Job" in Description
Result Codes
Update description and next steps for result code 10073
Update and next steps for result code 5020.
Update description for result code 1001
Callback Processes - SIM Bulk Transfer Callback
Update request example
Plan - Create & Plan - Modify
updated description for the parameter "action" under the "Input usageCounter Parameters" section
Rule
Update examples - Update the values of parameter "ruleid"
Endpoint Tags
New section for endpoint Tags related APIs
Tag - Create
Tag - Modify
Tag - Get
Tag - Delete
Tag - Create
New result code 10120: "Maximum number of tag is reached"
Endpoint - Modify & Endpoint - Bulk Modify
Support modify of endpoint name. New parameter "endPointName" under "Input requestParam Parameters" section Added examples for modifing endPointName
Plan - Modify
Update the description for parameter "planStatus" under INPUT BASICINFO PARAMETERS section
Organization - Create
New value for parameter "customerType" under "Input requestParam Parameters" sections.
4.8.0 - February 16, 2023
Get Hierarchy API - NEW API!
New API used for fetching accounts under an hieararchy API is available under MISC Information section.
NEW Callback Process for Account Events
New callback process where the User can define his callback URL to receive Account events. For more information check Callback Process section under "Enterprise Tools"
NEW Callback Process for Endpoint Events
New callback process where the User can define his callback URL to receive Account events. For more information check Callback Process section under "Enterprise Tools"
GET SIM
New query parameters are added to allow filtering of the results. Specifficlay - simStatusId - simAttachStatusId - simProductID - accountId For more information on how to use new parameters please check API and available examples
NOTE: for simProductID, you can find all available IDs in then new "SIM Products" section
New parameters "lastSimStateChangeDateTime" and "activationCode" under "Output SIM Parameters "
New "Output Activationcode Parameters" section with parameters: matchingId, textQrCode and smDpPlusAdress
SIM Products
New SIM Products section with all available SIM products names and their IDs.
Can be used as a reference to find the ID that needs to be used with the simProductID query parameters on the GET SIM api.
Get Endpoint Profile
New output parameter lastSimStateChangeDatetime under OUTPUT BASICINFO PARAMETERS . Used to identify the datetime of the last SIM state change.
New output parameter resetDate in the OUTPUT COUNTER PARAMETERS
Callback APIs
Resolved issue with authentication token. If it is provisioned in the callback configuration it will now be used when calling the callaback API.
GET CallBack Information
Added new result code 11005 with description 'Get callback profile failure '
POST Endpoint - Create
Added new result code 10201 with description "The option Dynamic Benefit only is enabled at parent level. Please subscribe the endpoint to a pooled or non-pooled dynamic benefit."
Result code 5015 with description "FAILURE - Invalid IMSI - In use " is removed since not valid anymore
PATCH Endpoint - Modify
Added a new parameter removeAddonPlanIds under INPUT REQUESTPARAM PARAMETERS . It can be used for removing the addon plans fromendpoints in ActiveTest and ActiveInventory status (OEM model)
Added new result code 10199 with description "Your request is under process"\***Added new result code ***10202 with description "One deactivate addon request is under process" Both codes are added as part of removing addon plans from an endpoint
Result Codes
Update the Result Code table to include - Added "Next Steps" section with suggested action you can take upon specific errors - Refer API: to identify which API is providing the specific Result Code.
Both above sections we will be updated continuously with more information to simplify the API troubleshooting
Removed result codes in result code section "1244, 8196, 7012, 7021, 8239, 10052, 10053, 10161, 8212, 1084, 10076, 10173 and 5112", because these result codes not using in any API's.
Added Result code 10002 with description 'Insufficient Privilege' (generic - valid for multiple APIs) Result Code 10198 with description 'Notification message length has been exceeded' (multiple APIs)
Updated 1417: updated description
Removed 10161, 1244, 8196, 7012, 7021, 8239, 10052, 10053, 10161, 8212, 1084, 10076, 10173 and 5112 as not valid
Plan - Create
Parameter message under INPUT MESSAGES PARAMETERS now supports 1000 characters for Mail channel and 200 for Enterprise SMS channel
Plan - Modify
Parameter message under INPUT MESSAGES PARAMETERS now supports 1000 characters for Mail channel and 200 for Enterprise SMS channel
4.7.0 - October 27, 2022
SIM BULK TRANSFER CALLBACK - NEW API!
New Callback API for receiving SIM Bulk Transfer results
CREATE ORGANIZATION
Parameter 'language' has been removed from INPUT REQUESTPARAM PARAMETERS.
Parameter used to be mandatory. It can still be used in the API but it will not be considered during the organization creation.
GET ENTPOINT PROFILE
Added "planId, planName, uniqueId, planCategory" in benefit array and Updated examples
Added two new parameter "balance" and "priority" under OUTPUT BENEFITLIST PARAMETERS
Added new parameter "priority" under OUTPUT DYNAMICBENEFITSDETAILS PARAMETERS
BULK SIM TRANSER
Added "associateTestPlanId" and "callbackResults" under Input requestParam Parameters Updated examples with "callbackResults"
Added success and failure examples for SIM transfer with resource type 'ValueRange'
Fix an issue with one of the examples (wrong resiult code)
GET CUSTOMER PROFILE
Added new parameter "dynamicBenefitId" under OUTPUT BENEFIT PARAMETERS
Added new parameter "Priority" under OUTPUT DYNAMICBENEFITSDETAILS PARAMETERS & OUTPUT BENEFITLIST PARAMETERS.
ACCESS TOKEN
New response when API request has timeout. Added Result code '10141' and new examples.
GET ENTPOINT BLACKLIST
Added new examples
GET ENTPOINT COVERAGE
Added new examples
PLAN MODIFY
Added clarifications for OEM plans, benefits and state transition rule modification (check Note at the end of the INPUT section)
Endpoint - Bulk Create
New option to provide ICCIDs as list. New parameter iccidList under INPUT BULKPROVISIONINGINFO PARAMETERS Update description for parameters 'creditLimit' & ''quantity under INPUT BULKPROVISIONINGINFO PARAMETERS New and updated examples
CallBack API - Usage Events
New parameter "supplierName" is available under ROWS (updated example)
CallBack API - Mobility Events
New parameter "supplierName" is available under ROWS (updated example)
Endpoint Link SIM
Added new result codes "10109" & "10108". Updated examples.
Endpoint Modify
New examples available.
Delete Service Profile
Removed result code "8196: Service profile attached to plan, so deletion failure "
Create Endpoint
Added new result code "5015". Updated example.
Result code 10077 with description 'Maximum limit reached for addons' has been removed. It has been replaced with result code 10073 with description 'Maximum count exceeds for input Parameter - {reason}'.
Endpoint - Delete
New result code 10158 for 'Delete Endpoint is not allowed. Please De-Link SIM first' added.
Create TAG
New API for Enterprises , to create TAGs for endpoints.
Get TAG
New API for Enterprises, to fetch available endpoint TAGs.
You can find it under Enterprise Tools Sections
Modify TAG
New API for Enterprises , used to modify existing endpoint TAGs.
You can find it under Enterprise Tools Sections
Delete Tag
New API for Enterprises , used to delete existing endpoint TAGs.
You can find it under Enterprise Tools Sections
Get Endpoints
Added
tagIdas new query parameter. It can be use to fetch all endpoints that have the specific TAG. TIP: Use "Get TAG" to find thetagIdthat corresponds to eachtagName
Endpoint De-Link SIM
New result code 6414 for 'SIM Delink Failure ' added.
Endpoint Geolocation
New result code 10089 for 'Endpoint is detached' added**.**
New result code "10089" for 'Endpoint is detached scenario' added.
APN Group - Modify
New result code 10123 for 'Failure.!! Not possible to remove last APN' added**.**
Create Plan
New result code 8098 for 'Duplicate operators present in the rate zone selected' added.
New result code 10106 for 'Prorate is not allowed with the Minimum fee charge' added together with new example. New result code is triggered when creating plan with Prorate and Minimum fee charge together.
Modify Rate zone
Result code 8212 with description "Atleast one operator should be attached to ratezone " has been removed since this error is not longer valid. We can modify rate zone without attaching single operator.
Modify Roaming Profile
Result code 10103 with description "Insufficient privilege" has been removed. It has been replaced with result code 10002 "Insufficient privilege".
GET SIM
New result code 10097 for 'Multiple query parameters are not allowed' added.
GET Charge
Result code 10005 with description 'Missing mandatory parameter' has been removed because this error code is not longer valid.
4.6.0 - July 7, 2022
DELETE ROAMING PROFILE - NEW API!
New API is available for deleting existing roaming profiles.
GET ENDPOINT COVERAGE - NEW API!
Used for fetching the coverage for an endpoint.
You can find it under ENDPOINT section.
ENDPOINT BLACKLISTING - NEW API!
Used for adding and removing network from the blacklist of an endpoint.
You can find it under ENDPOINT section.
BULK SIM TRANSFER - NEW API!
Added new API for bulk sim transfer in organization section
You can find it under ORGANISATION section.
ENDPOINT TAGs
The following APIs have been updated to support Endpoint TAGs: Endpoint Create, Get Endpoint Profile, Get Endpoints, Endpoint Bulk Modify, Endpoint Bulk Create, Endpoint Modify.
More info below
ENDPOINT CREATE
Added new parameter "tagIds" under INPUT REQUESTPARAM PARAMETERS
ENDPOINT MODIFY
Added new parameters "addtagIds" and "removetagIds" under INPUT REQUESTPARAM PARAMETERS
ENDPOINT BULK CREATE
Added new parameter "tagIds" under INPUT BULKPROVISIONINGINFO PARAMETERS
ENDPOINT BULK MODIFY
Added new parameters "addtagIds" and "removetagIds" under INPUT REQUESTPARAM PARAMETERS
GET ENDPOINT
Added new Output parameters section "TAGIDLIST" with the following parameters: "tagName", "tagId" and "tagDescription"
GET ENDPOINT STATISTICS
Updated to provide statistics for NBIoT usage,
New parameters added "nbiotUsage"", "nbiotTotalUsage", "smsTotalUsage", "dataTotalUsage"
New examples available
GET ENDPOINT PROFILE
Added new Output parameters section "TAGIDLIST" with the following parameters: "tagName", "tagId" and "tagDescription"
Support for Blacklisted Networks. New parameter "blacklistedNetworks" Removed parameters "language" and "languageName"
PLAN CREATE
New parameters have been added to support creating and attaching Dynamic Benefits.
Removed parameter "language"
PLAN MODIFY
New parameters have been added to support Create, modify, delete, detach and attach Dynamic Benefits.
Removed parameter "language"
QUERY RATE PLAN
New parameters have been added for Dynamic benefits and benefits section.
Removed parameter "language" and "languageName"
GET NOTIFICAITON
New counter notifications for NB-IOT and Data are supported and available in the output :"NB-IOT Counter Notification" and "Data Counter Notification"
Updated example
GET CUSTOMER PROFILE
Removed parameters "language" and "languageName"
GET JOB STATUS
We have moved Get JobStatus from Enterprise tools section to Organization section,
CREATE ROAMING PROFILE
Updated description for Result Code '10098'.
4.5.1 - May 5, 2022
Endpoint Modify
Updated description for "removeDynamicBenefitIds" under INPUT REQUESTPARAM PARAMETERS
Plan Create
Updated description for "factor" and "frequency" under INPUT CHARGE PARAMETERS
Plan Modify
Updated description for "factor" and "frequency" under INPUT CHARGE PARAMETERS
Get Job Status
New Result Code added
"10175 - Request under processing "
Same code was added under Results Codes
Multiple endpoints
For multiple endpoints (APIs) the documentation was updated to include the output "Response" parameter to match API response
This is a "Documentation" only change that does not affect API actual response.
Result Codes
Added new result codes 10125 & 10126 for API timeouts
Result code 10031 was removed from the documentation of certain endpoints and moved under Result Codes.
4.5.0 - March 23, 2022
Destination Group
Pagination was not supported hence removed from the documentation.
Tariff - Create
New parameters "p2pOffnetSMS and ppuDestCriteria ", under INPUT TARIFFDETAILS PARAMETERS, for creating SMS-MO Tariff request.
Updated description for "pulse" and ppu".
Tariff
New parameters "p2poffnetsms" and "ppuDestCriteria" under OUTPUT TARIFFLIST PARAMETERS
Updated description for "pulse" and ppu".
Tariff - Modify
New parameters in modify request "ppuDestCriteria and p2pOffnetSms" under INPUT TARIFFDETAILS PARAMETERS
Updated description for "pulse" and ppu".
Plan - Create
Updated description of parameters "applicableFor", "factor" and "frequency" in the Input charge Parameters section
Added a new parameter priceAboveIncludedPerNetwork in the Input charge Parameters section
Added new section of parameters "priceAboveIncludedPerNetwork"
Modified example "Create Plan - Success - {Postpaid Base Plan}" with all the new & updated parameters listed above.
Added Result code(10169) and relative example.
Plan - Modify
Updated description of parameters "applicableFor", "factor" and "frequency" in the Input charge Parameters section.
Added a new parameter setPriceAboveIncludedPerNetwork & removePriceAboveIncludedPerNetwork in the Input charge Parameters section
Added a new section Input setPriceAboveIncludedPerNetwork parameters
Added a new section Input removePriceAboveIncludedPerNetwork parameters
Modified example "Modify Plan - Success - {All Parameters}" with all the new & updated parameters listed above.
Query Rate Plan
Updated description of parameters "applicableFor""factor" and "frequency" in the Output charge Parameters section
Added a new parameter priceAboveIncludedPerNetwork in the in the Output charge Parameters section
Modified example "Query Rate Plan - Success" with all the new & updated parameters listed above.
APN Group - Modify
Added new Result code and Description
Customer Profile
Update description of the dynamicBenefitsDetails in OUTPUT BENEFITINFO PARAMETERS
Update description of the category in OUTPUT DYNAMICBENEFITSDETAILS PARAMETERS
Endpoint - Create
New resultcode 10140
Endpoint - Modify
Updated addDynamicBenefitsIds and removeDynamicBenefitsIds description in INPUT REQUESTPARAM PARAMETERS
Added new Note for OEM enabled accounts under "INPUT REQUESTPARAM PARAMETERS". Check field description for more information.
Update result codes (4 new)
Removed failure example of adding addon plans to Active-Test and Active-Inventory endpoints
Endpoint Bulk Modify
Updated addDynamicBenefitsIds and removeDynamicBenefitsIds description in INPUT REQUESTPARAM PARAMETERS
Delete Endpoint ----- NEW !!!
Added new API "POST DeleteEndPoint. You can find it under the Endpoint section
Endpoint - Change Roaming Profile
New failure example of passing TEST roamingProfileId in the input request parameter
Endpoint - Threshold
Added a note in the description for Input request parameter endPointId
Endpoint - Plan change
Added new Result code, Description and Example
Data Stream Callback (MobilityEvents)
Added new field "timestampAccount" in ROWS. Check field description and examples for more information.
Benefit
Added new values for parameter 'serviceId' and 'rat type' under OUTPUT BENEFITLIST PARAMETERS for NB-IOT support.
New example added.
Counter
Added new value for parameter 'serviceId' under OUTPUT COUNTERLIST PARAMETERS for NB-IOT support.
Notification
Added examples for NB-IOT
Customer Profile
Updated parameter 'benefit' under OUTPUT BENEFITLIST PARAMETERS for NB-IOT support.
Result Codes
Updated with new codes mentioned above (10140, 10169)
4.4.0- November 25, 2021
Service Profile - Modify
Support for new 5G access type (Added new example and updated the description for "accessType" parameter under INPUT SERVICEPROFILE PARAMETERS)
Service Profile - Create
Support for new 5G access type (Added new example and updated the description for "accessType" parameter under INPUT SERVICEPROFILE PARAMETERS)
GET Service Profile
Support for new 5G access type (Added new example and updated the description for "ratTypeName" parameter under OUTPUT SERVICEPROFILELIST PARAMETERS)
EndPoint - Create
Added "valueAddedFeatureIds" parameter under INPUT REQUESTPARAM PARAMETERS and in the examples
EndPoint - Modify
Added new parameters "addValueAddedFeatureIds" and "removeValueAddedFeatureIds" under INPUT REQUESTPARAM PARAMETERS. New example is also added
EndPoint - Bulk Modify
Added new parameters "addValueAddedFeatureIds" and "removeValueAddedFeatureIds" under INPUT REQUESTPARAM PARAMETERS. New example is also added
EndPoint - Bulk Create
Added new parameters "valueAddedFeatureIds" under INPUT BULKPROVISIONINGINFO PARAMETERS. New example is also added
Get Networks - Failure
Added new example and new result code 10115.
Plan Create
Added MESSAGE SUPPORTED IDENTIFIERS 39 40 41 42 as part of the new notification feature "SIM and Endpoint Status Change"
Plan Modify
Added MESSAGE SUPPORTED IDENTIFIERS 39 40 41 42
GET Notification
Added in example for notification type "Endpoint and SIM Status Change"
GET Endpoints
API now supports Pagination. Added examples
Added Input Query Parameters in description.
Endpoint - Status Change
Added new description in Result code for 5017 and 9003
Access Token
New feature to enable API support access to child accounts
Data Stream Callback (UsageEvents)
Update and correction on existing example.
GET Customer Profile
Added new example "Get Customer Profile - Success - {Deactivated Account}" for deactivated accounts
Removed Roamingprofileid tag from the description as well as from the examples
Update and improve the description for the following parameters, under OUTPUT BASICINFO PARAMETERS : currentStatus, currentStatusName, currencyId, tierId, timeZoneId, creationDate, subscriberType, subscriberTypeName, dependendRatType.
GET Endpoint Profile
Added new Example "Get EndPoint Profile - Success {Nonpooled/pooled Endpoint}"
Update and improve the description for the following parameters, under OUTPUT BASICINFO PARAMETERS: subscriberType, subscriberTypeName, currencyId, tierId, roamingProfileId, roamingProfileName, timeZoneId.
GET Service Profile API
updated description for 'serviceName' and removed 'radioAccessTypeUpdate' parameter.
Destination Group - Create, Modify
Added note how to fetch attached network details and find info required for Destination Group creation/modify.
Roaming profile - Create, Modify
Added note how to fetch attached network details and find info required for creation or modifying Roaming Profile.
A2P SMS (Callback API)
Documentation title renamed to "A2P SMS Status (Callback API)" for better clarify on the scope of the specific API and provide updated API description for the same reason.
P2A SMS (Callback API)
Update API description for better understanding of the API scope.
4.3.1 - September 20,2021
Update Monthly Limit(Postpaid)
Added new result code 1394 and description "Successful!! request has sent for processing!!"
Update Balance (Prepaid)
Added new result code 1394 and description "Successful!! request has sent for processing!!"
Updated GET Currencies
Added new result code 1384 and description "No currency exists"
Updated GET Timezone
Added new result code 1385 and description "No timezone exists"
Updated GET EndPointProfile
Removed the following optional parameters from description and examples since they were not included in the responses: "firstCallDate, featureId, featureName, featureValue, profileId, profileName, isGSM, isCDMA, isLTE, isUMTS".
Updated GET CustomerProfile
Rename "Ycode" optional parameter to "YCode" in OUTPUT BASICINFO PARAMETERS
Update description for the parameter onBoardType
Update examples
Updated GET CustomerProfile API
Added parameter and Example
Updated GET EndpointProfile API
Added parameter and Example.
Updated CreateEndPoint API
Update description for the parameter dynamicBenefitEnable, benefits.
Updated bulkProvisioning API
Update description for the parameter dynamicBenefitEnable, benefits.
Updated endpoint API
added example and addDynamicBenefitsIds, removeDynamicBenefitsIds parameter
## Updated endpointbulk API
added example and addDynamicBenefitsIds, removeDynamicBenefitsIds parameter
4.3.0 - July 13, 2021
Service Profile - Modify
Added new example and new result code 10100.
Support for new NB-IOT service type (Added new example and updated the description for "service" parameter)
Service Profile - Create
Support for new NB-IOT service type (Added new example and updated the description for "service" parameter)
New Result code 10111
GET Service Profile
Support for new NB-IOT service type (Added new example and updated the description for "serviceName" parameter)
Destination Group - Create
Changed the result code SC0025 to 10098 in the example and Result code table
GET Destination Group
Updated the example and Description for GET Destination Group
Added new parameter "supportedNetworkTypes" in the OUTPUT TADIGLIST PARAMETER table and updated the example response
GET Roaming Profile
Updated the example and Description for GET GetRoamingProfiles
Added new parameter "supportedNetworkTypes" in the OUTPUT TADIGLIST PARAMETER table and updated the example response
GET RateZone
Updated the example and Description for GET GetRateZone
Added new parameter "supportedNetworkTypes" in the OUTPUT OPERATORIDLIST PARAMETERS table and updated the example response
Tariff - Create
Updated description in Create Tariff Api
Added new parameter "serviceId" ="5 - NB-IOT"
Get Tariff
Updated description in Get Tariff Api
Added new parameter "serviceId" ="5 - NB-IOT" .
Plan - Create
Added new examples for multiple onetime fee and OEM plans.
Added new result codes 10110, 10119 & 10120
Updated the example and Description for Create Plan API (Charge section)
Added four new parameters "applicableFor, includes, numberIncluded and priceAboveInclude".
Updated actionType description
Updated the description and added new examples for create plan API
Added new parameters for TEST and Inventory plan creation, NEXTPLANRULES, new examples for test and inventory plan
Plan - Modify
Added new example for multiple onetime fee enabled charge
Added new parameter in removecharge section
Added new result code
Updated the example and Description for Modify Plan API (Charge section)
Added four new parameter: applicableFor, includes, numberIncluded and priceAboveInclude.
Updated the description and added new examples for Modify plan API
Added new parameters for TEST and Inventory plan modification, NEXTPLANRULES, and new examples for test and inventory plan
Query Rate Plan
Added new example for multiple onetime fee enabled charge
Added new tags in the output charge parameters: instanceId, instanceTimestamp, applicableForId, applicableForName, includesId, includesName, numberIncluded, priceAboveIncluded
Removed redundant parameters in BasicInfo block "frequency" and "factor".
Removed duplicate parameters in OUTPUT BASICINFO "planName" and "planDescription"
Updated the example and Description for GET Query Rate Plan API (Charge section)
Added four new parameters "applicableForId, applicableForName, includesId, includesName, numberIncluded and priceAboveIncluded".
Added new Test and Inventory Plan examples in GET Query Rate Plan and described the new parameters
Added new query parameter values for TEST and INVENTORY plans
GET APN Group
Updated the Description for the API fetchAttachedAPN
Changed the account access for Resller to "No"
Get Customer Profile
Added two new tags rdbCode and countryISO3 in the description and examples
Added two new parameters "rdbCode" and "countryISO3"
Updated Example and description in Get Customer Profile API
Added example and new parameter "enterpriseNbiotService"
Get Endpoint Profile
Updated Example and description in Get Endpoint Profile API
Added example and new parameter "enterpriseNbiotService"
GET SIM
Updated Example and description in Fetch SIM API
Added new tag "associatedTestPlanIds" in output parameter section in Fetch SIM API
Create Organization API
Added new example and updated description for create Organisation API
Added new example for OEM enabled Account creation and new tag "isOemEnabled" is added in input request parameter section
Data Stream Callback (MobilityEvents)
Updated the description for Callback process Mobility events API
Added new parameter IMEI in the ROWS table and updated the example response
Updated the description for Errorcause, Errorcode parameter
Get Charge
Added new example for Same one time fee multiple times per settlement product
Added one new tag "isallowMultipleOnetimeFee" in the output charge parameters
Updated the description for settlementProductSFT and settlementProductM2MIC
Update the Example for GET Charge (OUTPUT CHARGELIST PARAMETERS)
Added new Charge "SFT-Feature based SIM management“
GET Networks
Updated the example and Description for GET fetchNetworkList
Added new parameter "supportedNetworkTypes" in the OUTPUT TADIG LIST PARAMETERS table and updated the example response
GET Invoice
Updated the Description for GET Invoice (OUTPUT BILLINGDETAILS PARAMETERS)
Added new parameter "simMonthlyActiveFeatureFee".
Added new parameter "NB-IOT" in description.
GET currency
Updated GET currency API examples
4.2.3 - 15/3/2021
Updated Callback API for usage events
Updated callabackUri parameter (from callbackURL to callbackUri) Added a note for ratingGroup1 paramter
Updated Callback API for mobility events
Updated callabackUri parameter (from callbackURL to callbackUri) Added new error codes for failure and success events in errorcause parameter's description
4.2.0 - 1/3/2021
Descriptions of Changes
New API for Callback API Modify (PATCH) (Enterprise tools > Callback Processes)
Added new result code in Plan modify API
Get SIM API, new Query parameters (msisdn, imsi, endpointid) and new SIM Output parameter (directCustomerAccountId)
Added description in Modify Service Profile API (POST) for the field Service in INPUT SERVICEPROFILE PARAMETERS
Updated description for Modify Destination Group API
New API for Data Stream(Usage Events and Mobility Events) Callback API POST (Enterprise tools > Callback Processes)
Updated description for Modify RP and added new example
Updated description for GET customer profile and added new example
Updated description for Create Endpoint
Updated description for Modify Endpoint and added new example
Updated description for Bulk Modify Endpoint and added new example in Getjob details
Updated description for GET Endpoint and added new example
Updated description for Endpoint Activation
Updated description for Endpoint Status change
Updated description for GET Endpoint profile
Updated description for GET SIM
Updated the description and added example for change roaming profile
Updated description for the Prorate & Factor parameters which are supported for new charge the "Monthly minimum fee" validation in the Create and Modify Plan API's
Updated example for the Create plan API (POST) with new charge ID for the monthly minimum fee
Added new resultcode in the Create plan API (POST)
Updated example for the Get charge API (GET)
Added new callback API (POST) for A2P SMS status with example.
Update values for Radio access type parameter for Get Service Profile
Update parameter values and descirption for Create Tariff
Update parameter values and descirption for Modify Tariff
Added new values for currentStatusName and currentStatus parameters for Get Customer Profile
Added new result codes, 10081 and 10074, in the result codes section
Updated Launch Date description in Create Organization API
Updated Result Code for Endpoint Plan Change API
API Changes
NEW API for Callback Information Modify (PATCH)
API is used to modify information for all callback API configuration of a particular customer(Callback URLs and Token)
Added API result description for modify plan API (POST)
Error code- 10088 - Result description - 'Modify plan not supported - planCategory'
GET SIM API: new query and output parameters
Support for msisdn, imsi and endpointid in the query parameters
New SIM Output parameter (directCustomerAccountId)
Added description for Modify Service Profile API (POST)
Added description which supports service modification for an INPUT SERVICEPROFILE PARAMETERS - Service
Updated description for Modify Destination Group API
Update description for addTadigCodeList about automatic propagation of added networks
NEW API for Data Stream Callback Usage Events
This API is used to send Usage Events of Data stream to the customer URL
NEW API for Data Stream Callback Mobility Events
This API is used to send Mobility Events of Data stream to the customer URL
Updated description for Modify RP and added new example
Updated this API for OEM enabled accounts in description and added new example
Updated description for GET customer profile and added new example
Updated this API for OEM enabled accounts in description and added new example
Updated description for Create Endpoint
Updated this API for OEM enabled accounts in the desciption
Updated description for Modify Endpoint
Updated this API for OEM enabled accounts in description and new examples for addons and imei
Updated description for Bulk Modify Endpoint
Updated description for Bulk Modify Endpoint and added new example in Getjob details for OEM accounts
Updated description for GET Endpoint
Updated description for GET Endpoint and added new example for OEM accounts
Updated description for Endpoint Activation
Updated description for Endpoint Activation for OEM accounts
Updated description for Endpoint Status change
Updated description for Endpoint status change with example for OEM accounts
Updated description for GET Endpoint profile
Updated description for GET endpoint profile with example for OEM accounts
Updated description for GET SIM
Updated description for GET SIM with example
Update for change endpoint roaming profile
Updated the description of the parameter roamingProfileIds and added new example
Update example for Create plan API (POST)
Updated the description of the "Prorate" parameter in INPUT BASICINFO PARAMETERS which supports for the newly introduced charge "Monthly minimum fee"
Updated the description of the "factor" parameter in INPUT CHARGE PARAMETERS which supports for the newly introduced charge "Monthly minimum fee"
Updated example for the Create Plan - Success - {Postpaid Base Plan} with included new charge id for the "Monthly minimum fee"
Added a new resultcode 10106 - Prorate is not allowed with the Minimum fee charge
Update example for Modify plan API (POST)
Updated the description of the "Prorate" parameter in INPUT BASICINFO PARAMETERS which supports for the newly introduced charge "Monthly minimum fee"
Updated the description of the "factor" parameter in INPUT CHARGE PARAMETERS which supports for the newly introduced charge "Monthly minimum fee"
Update example for Query Rate plan
Added a new example
Update example for GET Charge API (GET)
Update success example "Get Charge - Success" with the new charge "Monthly minimum fee"
New API for A2P SMS status callback (POST)
New A2P SMS (Callback API) example added with the callback description
Update API - "Get Service Profile"
Changed the uppercase letters to lowercase latters in Radio access type (true/false).
Update API - "Create Tariff"
Corrected the description of “Minimum Session Fee(Minimum Session Fee, applicable only for serviceId=4(Data) in Enterprise level).
Changed 5 – RG-Online to 5 – Default in ratingGroup.
Removed 2 – RG-OTA in ratingGroup.
Corrected the description for UnitType (COUNT for MT-SMS & MO-SMS MB and KB for Data).
Update API - "Modify Tariff"
Corrected the description of “Minimum Session Fee(Minimum Session Fee, applicable only for serviceId=4(Data) in Enterprise level).
Changed 5 – RG-Online to 5 – Default in ratingGroup.
Removed 2 – RG-OTA in ratingGroup.
Corrected the description for UnitType (COUNT for MT-SMS & MO-SMS MB and KB for Data).
Update API - Get Customer Profile"
Added PA for currentStatusName.
Added PreActive for currentStatus.
Update Resultcode
Changed the description of resultcode:"1892"
Added new resultcode:"10081" "resultDescription": "Restricted words (like delete ,drop ,truncate etc) should not be used for name "
Added new resultcode:"10074" "resultDescription"": ""Failure!! Unrecognized field-essageType "
Updated Launch Date description in Create Organization API
Updated description for Launch Date parameter in Create Organization API
Updated Result Code for Endpoint Plan Change API
Updated error message for result code 5019 for Endpoint Plan Change API
4.1.2
Minor release for documentation fixes
Update API - "Geolocation Information"
Moved under "Endpoint" and renamed to "Endpoint Geolocation".
Convert all numeric output in decimal format (CellID, and Tac were coming in HEX under 4G).
Update API - "Get customer profile"
Added two more params benefit and benefit Id in output response under basicInfo section.
Update API - "FetchSIM"
Corrected the spelling of 'available' in output parameters description. Added parameter 'result code' under output params
Update API -"CreateEndPoint"
Added result code 6409 under result code section in the document as well as in the sample response.
Update API - "Modify Plan"
Notification type , threshold type and threshold value were made mandatory and conditionaly mandatory under input notification parameter section.
Capital letter in parameter Phone number under result description is changed to small letter.
Update API - "Create Plan"
Notification type , threshold type and threshold value were made mandatory and conditionaly mandatory under input notification parameter section.
BULK PROVISIONING API - Bulk create
Added description for the parameter isdefaultactivation
Get Bulk provisioning details
Added a new example
Update API - "Get customer profile"
updated the discription for the paramerter apn and updated the example.
4.1.0 - October 23, 2020
Descriptions of Changes
New Callback API Notification Framework (Callback Processes under Enterprise Tools)
New Callback Process for Notification (Enterprise tools > Callback Processes)
New Callback Process for P2A SMS (Enterprise tools > Callback Processes)
New API for Geolocation Information (GET) (Enterprise info)
New API for A2P SMS (POST ASYNC) (Enterprise tools)
New API for Callback API (GET) (Enterprise tools > Callback Processes)
Enhancement in SMS - Send to Endpoint API.
Enhancement of Endpoint - Bulk Create (POST) API
Enhancement of Endpoint - Bulk Create - Process Status (GET) API
Enhancement of Modify Service profile (POST)
Enhancement of Job Status API to support A2P Async API
New Input parameter (notification channel) in Create, Modify Plan and Query rate plan API's.
Updated the description of charges under plan related to SIM Management fee in Create, Modify Plan and Query rate plan API's.
API Changes
NEW Callback Process for Notification
Callback process where the User can define his callback URL to receive Plan Notifications.
NEW Callback Process for P2A SMS Notification
Callback process where the User can define his callback URL to receive P2A SMS.
NEW API for Geolocation Information (GET)
API is used to fetch endpoint location info.
New API for A2P SMS (POST)
API is used to send SMS from applicaiton to endpoint (A2P).
NEW API for Callback Information (GET)
API is used to fetch Callback configuration of the user (Callback URLs and Token)
Update API "SMS - Send to Endpoint" (POST)
Updated the description part for messageType field.
Updated the description part for message field.
Update API - "Endpoint - Bulk Create" (POST)
Added a new INPUT BULKPROVISIONINGINFO PARAMETERS "isDefaultActivation"
Updated "Endpoint Bulk Create - Success" example with the new parameter "isDefaultActivation"
Update API - "Endpoint - Bulk Create - Process Status" (GET)
Added a new input QUERY PARAMETERS "endpointStatus"
Added mandatory OUTPUT RESPONSE PARAMETER "endpointStatus"
Updated mandatory OUTPUT RESPONSE PARAMETER "endpointStatus" in Endpoint Bulk Create - Process Status - Success - {All} and example and Endpoint Bulk Create - Process Status - Success - {Specific} example.
Update API "Job Status" (GET)
Moved "Job Status" API under Enterprise Tools section
Updated the description part for OUTPUT RESPONSEPARAM PARAMETERS (A2P SMS JOB)
Added A2P SMS responseParam Result codes
Updated the description part for Result Codes
Added example :Job Status - A2P SMS Job - Success
Removed example Job Status - Bulk Endpoing Modify Job - Success
Added example Job Status - Bulk Endpoing Modify Job - Failure
Updated example :Job Status - Bulk Endpoing Modify Job - Success
Update API "Create Plan" (POST)
Updated INPUT RECIPIENTS PARAMETERS with the new notification channel for "API" and new tag for "callBackType"
Updated Success example enriched with new notification channel and new callback tag under notification recipients parameters
Updated the description of "channel" under the INPUT MESSAGE PARAMETERS section
Updated the description of "charges" under the INPUT CHARGE PARAMETERS section
Update API "Modify Plan" (POST)
Updated INPUT RECIPIENTS PARAMETERS with the new notification channel for "API" and new tag for "callBackType"
Updated "thresholdValue" parameter with the fixed and slab based values
Updated the description of "channel" under the INPUT MESSAGE PARAMETERS section
Updated the description of "charges" under the INPUT CHARGE PARAMETERS section
Update API "Query Rate Plan" (GET)
Updated OUTPUT RECIPIENTS PARAMETERS with the new notification channel for "API" and new parameter for "callBackType"
Updated an example "Query Rate Plan - Success - {Base Plan Only}" showing new parameter "callBackType" and new notification channel "API" in OUTPUT RECIPIENTS PARAMETERS.
Updated the description of "charges" under the OUTPUT CHARGE PARAMETERS section
Update API - "Modify Service Profile" (POST)
Added new result code and description for "10085" for ratType modification
Added example for Modify Service Profile(ratType)
Update API - "Destination Group - Modify"
Updated examples for "Destination Group - Modify".
4.0.2 - August 19, 2020
Descriptions of Changes
Enhance Notification with Account name and endpoint name in Plans
Support for One Time Bundles in Plans
You can add and remove Addons using Endpoint Modify
You can add Addons using Endpoint Bulk Modify
Support for Benefit Notifications (Thershold/Consumption) in Plans
Improve Endpoint Statistics
Support for Prorated plans
Improvements in Endpoint Modify and Endpoint Bulk Modify
API Changes
Update API "Create Plan" (POST)
New INPUT BASICINFO PARAMETER: prorate
Message input parameter now supports identifiers
Updated description for Input charge Parameters factor and frequency for One Time Bundles support
Updated description for "factor and frequency" under Input charge Parameters.
Updated description for "activatedby" under BASIC INFO PARAMTERS.
Updated description for "thresholdValue" (fixed & slab) under INPUT NOTIFICATION PARAMETERS.
Updated descriptions for "email"and "phone" under INPUT RECIPIENTS PARAMETERS.
New example added for Onetime Addon Plan and updated the example of "Postpaid Base plan Success" showing new parameter "prorate".
Update API "Modify Plan" (POST)
New INPUT BASICINFO PARAMETER: prorate, addOnPriority and activatedBy
Message input parameter now supports identifiers
Removed planCategory,serviceProfile,currencyId,destinationGroup,planType from INPUT BASIC INFO PARAMETERS.
"planName" and "planStatus" under BASIC INFO PARAMETERS are optional now.
New INPUT BASIC INFO PARAMETERS:addOnPriority,activatedBy
parameter name changed from actions to "actionType" under INPUT CHARGE PARAMETERS
Updated description for "factor and frequency" under Input charge Parameters.
Updated description for thresholdValue (fixed & slab) under INPUT NOTIFICATION PARAMTERS
Updated description for "email" and "phone" under INPUT RECIPIENTS PARAMETERS.
Update API "Query Rate Plan" (GET)
Added new sections OUTPUT NOTIFICATION PARAMETERS, OUTPUT MESSAGES PARAMETERS and OUTPUT RECIPIENTS PARAMETERS
Updated an example "Query Rate Plan - Success - {Base Plan Only}" showing OUTPUT NOTIFICATION PARAMETERS, OUTPUT MESSAGES PARAMETERS and OUTPUT RECIPIENTS PARAMETERS.
New optional paramter "notification" under OUTPUT PLAN PARAMETERS.
Update definition for Output charge Parameters frequency for Base Plan and Addon Plan.
Updated Success example enriched with prorate parameter under basic info.
Update API "Endpoint - Modify" (PATCH)
New INPUT REQUESTPARAM PARAMETERS: addAddonPlanIds and removeAddonUniqueIds
INPUT REQUESTPARAM PARAMETERS "imeiLockStatus" changed to Optional
Remove OUTPUT RESPONSEPARAM PARAMETERS
Update API "Endpoint - Bulk Modify" (PATCH)
New INPUT REQUESTPARAM PARAMETERS: addAddonPlanIds
INPUT REQUESTPARAM PARAMETERS "imeiLockStatus" changed to Optional
Update API "Endpoint Profile" (GET)
New parameter "thresholdValue" added under OUTPUT COUNTER PARAMETERS.
Updated Success example with the promotionalPlans and benefit.
Update API "Charge" (GET)
Update definition for frequency under OUTPUT CHARGELIST PARAMETERS.
Update API "Notification" (GET)
Updated Success example enriched with Base plan benefits for GET notification.
Update API "Endpoint - Statistics" (GET)
New set of output parameters (SMSTOTALUSAGE and DATATOTALUSAGE) for a sum of SMS and Data Usage
API Result Code Description and updated Examples for Modify Destination Group, Update Monthly Limit (Postpaid) and Update Balance (Prepaid)
3005 error code description changed to "Update endpoint/customer success"
3006 error code description changed to "Update endpoint/customer failure"
4.0.0 - July 9, 2020
Descriptions of Changes
Support of IMEI lock using API.
Review of all parameters to improve and correct description.
API Changes
New API "Endpoint Modify" (PATCH)
API can be used to lock or unlock the IMEI status of a single Endpoint.
New API "Endpoint Modify Bulk" (PATCH)
API can be used to lock or unlock the IMEI status of multiple Endpoints (up to 1500). The actual endpoint modification is an asynchronous process. Upon request, the user receives a Job ID that can use as input in another API (Job Status) to check for the status of the bulk request.
New API "Job Status" (GET)
API is used to get the status of an Asynchronous job. For the current time it is used to get the status of the "Endpoint Modify Bulk"
Update API "Endpoint Create" (POST)
You can define the IMEI Lock status (lock or unlock) during endpoint creation.
You can define an Addon to be provisioned during endpoint creation.
You can assign a Multiple Dynamin Beneifit (if it is enabled) during endpoint creation.
Update API "Bulk Endpoint Create" (POST)
You can define the IMEI Lock status (lock or unlock) during endpoint creation.
You can define an Addon to be provisioned during endpoint creation.
Update API "Endpoint Profile" (GET)
IMEI lock status (imeiLockStatus) is no part of of the output
Update API "Endpoints" (GET)
IMEI lock status (imeiLockStatus) is no part of of the output
Update API "Create Organisation" (POST)
Added custom parameter (extIdentifier) that can be used to identify customer
3.3.7
The following summarizes the changes applied in the word documentation from version 1.29 till version 1.35
API v1.30 - 16 November 2019
Added account access table for all the API(s).
API v1.31 - 10 December 2019
Get Network List
Output tadig list Parameters OperatorID added
Create Tariff
Input tariffDetails Parameters ratingGroup: added possible values in the description unitType: add support for KB rateZone: changed from Mandatory (M) to Conditional Mandatory (CM)
API v1.32 - 17 December, 2019
Create Plan
removed planId option from Create Plan Added Addon Plan creation sample request
API v1.33 - 01 April, 2020
• Added Header Format for Get API • Header Format for Post API • Removed Header from request JSON from all the API(s) • Added NBIOT for cancel location API description and in Rat type • 5.59.7 Added corrected as “simProvisionId” • 5.53 Get Customer Profile, Added some parameter which is not mentioned in API document but still it is part of response • Added missing parameters in Get Endpoint Profile
API v1.34 - 24 April, 2020
Format & color issue corrected
API Description corrected for some of API’s
Parameter description corrected for some of API’s
Missing result code added in result code section for some of API’s
Sample response json, upper case in between the sentence has been changed to lower case
Create endpoint
Added new tab dynamicBenefitEnable & benefits(3.3.0) Endpoint id made optional
Fetch SIM
Removed page and per page from URL
Get Endpoint profile
FramedIP, dynamicBenefitEnable, benefits, benefitIds added in response parameter Endpoint id was duplicate and removed
Get invoice
Added rental amount added in response parameter
Get statistics per endpoint
“responseParam” is added in the Response Parameters
Get Service Profile
radioAccessTypeUpdate added in response parameter
Response id added in output parameter for
Get country, Get currency, Get timezone, Get Charge, Get Counter, Get Benefit, Get Rate zone, Get rule, get notification type, get tariff
resultCode added in output parameter for
Get Attached APN, Get ICCID for Bulk SIM Provisioning
Get Charge
Corrected URL to mode=1
Get tariff
minSessionFee & ratingGroup added in response parameter
Get Customer Profile
Onboard type added in response parameter
Account id removed from response parameter
Update balance
Get ICCID for Bulk SIM Provisioning
responseParam added
Get Bulk SIM Provisioning Detail
Result code added Response param added
API v1.35 - 8 May, 2020
Improve parameter description
Correct Typo