Release 4.1.0 - October 23, 2020
Online access to all API documentation – easily locate the most up-to-date information you need on our extensive suite of APIs by simply following the link now available in your portal. To view our online API documentation now, please click here.
Greater visibility and control of your device data – usage events from your connected devices can now be downloaded automatically. This process is secured via pseudo real-time SFTP-based file transfer straight to your data center.
Improved usage-based notifications in real time – it’s now possible to configure data and SMS notifications based on predefined usage limits for your devices. With the help of our new REST-based call-back APIs, usage and end device-related events can be configured for real-time notification directly to your data center.
Greater support for SMS delivery – we’ve integrated new SMS APIs to enable application-to-person (A2P) messaging, person-to-application (P2A) messaging and SMS status retrieval (delivery reports), allowing your devices to communicate data and configurations to your application server and vice versa.
Complete data and SMS plan flexibility – activate additional or ad hoc data and SMS bundles without impacting the underlying plan for when your devices are on the move. You can now also pro-rate charges and plans for the initial subscription month based on the date of activation, so your devices are ready to go whenever you are.
Increased geolocation capabilities – identify and map the precise cell tower that your device is served by at any given time, which can then be easily converted into map coordinates with the help of third-party databases.
Easily provision and configure thousands of devices – bulk provision and configure devices at scale via API, while retaining the flexibility to activate SIMs collectively or one by one as needed, avoiding unnecessary charges.
Descriptions of API 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".