This article includes:
- Create Express Activation Profiles (EAPs)
- Setup your users
- Thresholds - usage and barring
- Time zone in the API
- Activation process
You must complete the following before you can start activating your SIMs.
Create Express Activation Profiles (EAP)
EAPs allow you to preconfigure how the device is to be activated. This means that when you activate SIMs through the API you must first create the EAP in PRiSMPro and use the EAP Code in the Activate Device method. You can create as many EAPs as needed, one for each configuration.
Note: If you find that you are not eligible for specific features or plans when creating your EAPs, contact your account manager.
Setup your users
Contact Support to create or designate which user will have API access. KORE Support can create your users, or you can create additional users on your own in PRiSMPro.
Thresholds – Usage and Barring
Thresholds and barring are set on your devices as part of your EAPs. You can edit your thresholds using modifyDeviceThresholds.
Time zone in the API
The time zone used in the API is the USA eastern time, which will change for daylight savings time. Refer to UTC in the glossary for additional information.
Activation process
- Call the activate device method using either activateDevice or activateToState.
Depending on the service type, you submit either a SIM number, ICCID, or ESN / MEID and receive back a Tracking Number.
Tip: You can use that same tracking number to view the request in PRiSMPro under the “Track Request Tab”. - queryProvisioningRequestStatus for the status of the provisioning request.
This method returns back a status of “pending” when the request is still in progress, or alternately a value of “completed”. - Query for SIM information, refer to the table on queryDevice to determine which one you need.
Use to see detailed information for a SIM or ESN / MEID. The Device Information object has the MSISDN / MDN, the IMSI / MIN, the SIM Number, features in the device profile, monthly plans, thresholds, and custom fields. The status of the Device will be “stock” when it is not active, which will then change to “active” after activation is complete.