Our knowledgeable support team and an awesome community will get you an answer in a flash.

API Reference

Untitled

A SIM that doesn’t have a removable physical device. The hardware is usually embedded in the device. Typically the SIM profile is deployed to a device by reading a QR code.

VSIM

Voice service that uses the 4G data service to provide calls.

VoLTE

This is the default data coding standard for XML documents and defines all the characters that can be used.

UTF-8

Signalling data protocol that used for ME to network communications.

USSD

Security protocol that ensures that data transmitted over the internet is encrypted.

SIMs that are part of an Open User Group can send and receive text messages to/from other mobile devices.

Essentially this refers to the next generation of mobile service technology after 3G. So 4G, 5G and beyond.

The request method to be used when submitting requests to the CSL SIM Insight API.

HTTP_POST

A software component that allows a SIM to host multiple profiles.

eUICC

SIMs that are part of a Closed User Group can only send and receive text messages using the management system. They cannot send or receive SMS to/from mobile devices.

SMS sent from a device and terminated over IP.

MOIP

MO_Mobile_Originated

MT_Mobile_Terminated

The network technology used (e.g. 2G, 4G), as provided by the network operator.

RAT_Radio_Access_Technology

Network-derived cell and location data available for certain SIM types.

LBS_Location_Based_Services

A report providing a daily breakdown of usage potentially chargeable within a billing month.

Daily_Traffic_Summary

A report providing a breakdown for each SIM of all usage that is potentially chargeable in a monthly billing period.

Monthly_Traffic_Summary

An individual data, SMS or voice usage event recorded for reporting and billing.

Traffic_Record

An additional security measure requiring a time-based code from an authenticator app when logging in.

2FA_Two_Factor_Authentication

Additional configuration settings applied to certain roles (e.g. Hide Groups, Prevent SMS Entry).

Role_Options

Defines the features, facilities and reports a user is permitted to access via the portal.

User_Role

A designation assigned to SIMs to organise them within a Distributor’s account.

Customer

A secondary distributor account under a parent distributor’s control.

Sub-distributor

The primary account holder managing SIMs and groups within the Portal.

Distributor

The page used to activate SIMs, move them between groups, change status, assign customers, modify warning levels and perform other management functions.

SIM_Action

A SIM that has been permanently closed and will no longer incur monthly charges.

Closed_SIM

A SIM in a group that is not Active but still contributes to the group count for charging purposes.

Deactivated_SIM

The operational state of a SIM (e.g. Active or Deactivated).

SIM_Status

Charges incurred when usage exceeds the bundle allowance within the home zone.

Out-of-Bundle_Charges

Usage occurring outside the Base Zone and charged at the rates shown in the tariff.

Out-of-Zone_Usage

The geographical zone included within the tariff for a group.

Base_Zone

A geographical pricing region defined in your tariff.

Zone

The projected end-of-month cost based on current usage trends.

Forecast_Charge

A configurable usage limit after which the SIM cannot perform chargeable traffic and is highlighted in red.

Cut-off_Level

A configurable usage threshold that highlights SIMs in orange and can trigger email and/or API notifications.

Warning_Level

The monthly allowance for data, SMS and/or voice included within the group’s monthly fee and aggregated across all SIMs in the group.

Bundle_Allowance

A group assigned so that a SIM automatically moves from Pending when its test allowance has been exceeded.

Auto-Activation_Group

A group used so that charging can be paused if SIMs are out of action. Typically not chargeable.

Suspended_Group

The group where newly ordered SIMs are placed. Often includes a small test data allowance before moving to a chargeable live group.

Pending_Group

A chargeable group where SIMs contribute to the bundle allowance regardless of whether they are Active or Deactivated.

Live_Group

A configuration container created to define functional state, regional restriction, bundle allowances, tariff definition and default warning and cut-off levels for SIMs.

Group

The population of SIMs managed on your account.

SIM_Estate

De-activated

Active

Update this, this is how insight assigns tariffs and pricing

group

Resilient SIM technology that continually tests connection quality and switches to a backup operator profile to keep devices online

rSIM

Swagger