LogoLogo
ProductsDevelopersAPI ReferenceContact Us
Super SIM
Super SIM
  • Super SIM
  • Super SIM's Available Networks
  • Super SIM’s Multi-IMSI Applet
  • Over-the-Air Updates
  • Get Started with Super SIM
    • Overview
    • Get Started with Super SIM, the Raspberry Pi 4 and the Waveshare 4G Hat
    • Get Started with Super SIM, the Raspberry Pi 4 and the Sixfab Base Hat
    • Get Started with Data Comms and the Raspberry Pi Pico
    • Get Started with Super SIM SMS Commands and the Raspberry Pi 4
    • Get Started with Super SIM SMS Commands and the Raspberry Pi Pico
    • Get Started with Super SIM IP Commands and the Raspberry Pi
    • Get Started with Super SIM IP Commands and the Raspberry Pi Pico
    • Get Started with Super SIM eSIM Profiles for eUICCs
    • Get Started with Super SIM Connection Events
  • How To
    • How to Set a Device’s APN for Super SIM
    • How to Enable Device Roaming for Super SIM
    • How to Determine Whether a Device Contains a Super SIM
    • How to Set up iPhones for Super SIM
    • How to Determine a Super SIM’s Status
    • How to Use Console Bulk Actions to Update Multiple Super SIMs
    • How to Download Bulk Super SIM Data
    • How to Use Super SIM Fleets and Network Access Profiles
    • How to Understand the Settings on your SIM
      • Base Settings Package
    • How and Why You Can Set Super SIM’s Network Attach Priority List
    • How to Set Up and Use a Super SIM VPN
    • How to Configure AWS for a Super SIM VPN
    • How to Make and Take IoT VoIP Calls via Super SIM
    • How to Use Super SIM Connection Events
    • How to use Super SIM eSIM Profiles
    • How to Monitor Super SIM Connection Events using AWS ElasticSearch and Kibana
    • How to Use OpenAPI Clients with Super SIM
  • Into Production
    • Prepare for Production Deployments with Super SIM
    • Super SIM Datasheet
    • Super SIM Network Timeouts
  • Works with Super SIM
    • Works with Super SIM: Quectel BG95
    • Works with Super SIM: Quectel EG21-G
    • Works with Super SIM: Quectel EG25-G
    • Works with Super SIM: Thales Cinterion EXS62-W
    • Works with Super SIM: u-blox SARA-R5
  • Cellular Module Knowledgebase
    • Overview
    • About AT Commands
    • Nordic Modules with Super SIM
    • Quectel Modules with Super SIM
    • Quectel Modules with the KORE Narrowband SIM
    • Simcom Modules with Super SIM
    • Telit Modules with Super SIM
    • Thales Cinterion Modules with Super SIM
    • U-blox Modules with Super SIM
    • Cellular IoT Terminology
    • Low-power Optimization for Cellular Modules
    • Four Best Practices for Cellular Module Registration
    • How to Determine Good Cellular Signal Strength
    • How Super SIM Devices Connect to Cell Networks
  • Super SIM API
On this page
  • Connection Event Types
  • Attachment Accepted
  • Attachment Rejected
  • Attachment Failed
  • Data Session Started
  • Data Session Updated
  • Data Session Ended
  • Data Session Failed
  • Connection Event Resource Properties
  • Location info properties
  • Network info properties
  • Error info properties
  • Tips and tricks
  • Start development with a Subaccount or a new Project
  • How to generate Attachment Rejected events
  • Get your data usage from Data Session Ended events if you can

Was this helpful?

  1. How To

How to Use Super SIM Connection Events

Powerful network insights streamed to you

PreviousHow to Make and Take IoT VoIP Calls via Super SIMNextHow to use Super SIM eSIM Profiles

Last updated 4 months ago

Was this helpful?

Super SIM Connection Events allow you to follow a Super SIM connected device's journey from when KORE first sees it trying to connect to our mobile core, to when it gets connected and starts to use data, to when it ends its data session. Once a device has successfully started a data session, update events will be published while the device stays connected to give you near real-time usage information for each Super SIM.

Every Super SIM Connection Event will be one of a set of specific event types. These event types are described below and use the same .

Connection Event Types

The following types of events may be emitted into the stream:

This flowchart shows when these events may be triggered once a device has powered up:

Attachment Accepted

Event type string: *.supersim.connection.attachment.accepted

Your device successfully authenticated with a cellular network and is allowed to connect to it. This means:

  • The Super SIM is ready or active.

  • The IMSI being used is allowed to connect to the network.

This event may not be published every time your device connects. For instance, it will not be published if the device has previously authenticated with the network, which has cached the device's permission.

Attachment Rejected

Event type string: *.supersim.connection.attachment.rejected

Your device's attachment request was rejected by the network. The device was unable to connect.

Rejections can occur because:

  • The Super SIM is still new or inactive.

  • The IMSI currently being used is not allowed to connect to the network.

To connect, your device will need to try a different network, use a different IMSI, or retry after the used by the Super SIM's Fleet has been updated to allow the network.

Attachment Failed

Event type string: *.supersim.connection.attachment.failed

Your device's attachment request failed for an unknown reason.

This event usually indicates a transient error which will resolve itself in time. When the device attempts to reconnect to the network, it may get a different result.

Data Session Started

Event type string: *.supersim.connection.data-session.started

Your device is connected to a network using a valid Super SIM APN, and can send and receive data.

Data Session Updated

Event type string: *.supersim.connection.data-session.updated

Your device has remained connected using a valid Super SIM APN, and can continue to send and receive data.

Data Session Ended

Event type string: *.supersim.connection.data-session.ended

The data_session_start_time, data_session_end_time, data_session_data_download, data_session_data_upload, and data_session_data_total properties can give you a complete picture of the data session, telling you how long the device's data session was maintained and how much data was exchanged over it.

Data Session Failed

Event type string: *.supersim.connection.data-session.failed

Your device's attempt to create or maintain a data session failed. The device can no longer send or receive data until a new data session is started.

Connection Event Resource Properties

The Super SIM events you receive are based on a common schema that defines the following properties. Some properties will not be present in every case. error will not be included if no error took place. Attachment-related events will not include data session-related properties. The data_modifier property is only included if the Super SIM has exceeded its data limit. The location and imei properties will be omitted if KORE didn't receive this information from the visited network.

event_sid

The event's SID. This is a copy of the ce_id header field.

event_type

The type of connection event. This is a copy of the ce_type header field.

timestamp

The UTC time in ISO8601 format when the event occurred.

account_sid

The SID of the Account that the Super SIM and this record relate to.

apn

The Access Point Name (APN) used to establish a data session.

data_modifier

Indicates if the Super SIM's data usage is blocked because the SIM has reached its data limit. Its value will be blocked if data use is blocked, or null if data usage is not blocked.

data_session_sid

A unique string ID identifying a data session.

data_session_start_time

The data session UTC start time in ISO8601 format.

data_session_end_time

The data session UTC end time in ISO8601 format.

data_session_update_start_time

The data session UTC update start time in ISO8601 format. For a data-session.updated or data-session.ended event, this time indicates the start of the window for which the update was published. The data usage values included with these events was consumed between this time and the data_session_update_end_time.

data_session_update_end_time

The data session UTC update end time in ISO8601 format. For a data-session.updated or data-session.ended event, this time indicates the end of the window for which the update was published. The data usage values included with these events was consumed between the data_session_update_start_time and this time.

data_download

The amount of data downloaded to the device in bytes between the data_session_update_start_time and data_session_update_end_time.

data_upload

The amount of data uploaded from the device in bytes between the data_session_update_start_time and data_session_update_end_time.

data_total

The total amount of data uploaded or downloaded by the device in bytes between the data_session_update_start_time and data_session_update_end_time. The sum of data_download and data_upload.

data_session_data_download

The cumulative amount of data downloaded to the device over the data session. The cumulative amount of data downloaded to the device in bytes between the data_session_start_time and data_session_update_end_time or data_session_end_time for data-session.ended events.

data_session_data_upload

The cumulative amount of data uploaded by the device over the data session. The cumulative amount of data uploaded by the device in bytes between the data_session_start_time and data_session_update_end_time or data_session_end_time for data-session.ended events.

data_session_data_total

The cumulative amount of data uploaded or downloaded by the device over the data session. The cumulative amount of data uploaded or downloaded by the device in bytes between the data_session_start_time and data_session_update_end_time or data_session_end_time for data-session.ended events. The sum of data_session_data_download and data_session_data_upload.

imei

The International Mobile Equipment Identity of the device using the Super SIM to connect. This may be null as it is not guaranteed that the visited network will pass on this information.

imsi

The International Mobile Subscriber Identity used by the Super SIM to connect.

ip_address

The IP address assigned to the device. This address is not publicly addressable.

sim_iccid

The Integrated Circuit Card Identification Number of the Super SIM this record relates to.

sim_sid

The Super SIM's SID.

sim_unique_name

The Super SIM's unique name.

fleet_sid

The SID of the Fleet to which the Super SIM is assigned.

location

network

rat_type

The generation of wireless ('radio access') technology that the device was using. This will be one of: 2G, 3G, or 4G LTE.

error

Location info properties

The event's location property provides information about the placement of the cell tower to which the device was or is connected. This information is not guaranteed to be send by the network, so this property may be null.

Property

Description

cell_id

The unique ID of the cell tower that the device was attached to.

lac

The location area code (LAC) of the cell tower.

lat

The tower's estimated latitude.

lon

The tower's estimated longitude.

Network info properties

The event's network property contains information about the visited cellular network that the device attempted to connect to or is connected to.

Property

Description

mcc

The Mobile Country Code (MCC) of the network that the Super SIM attempted to connect to or is connected to.

mnc

The Mobile Network Code (MNC) of the network that the Super SIM attempted to connect to or is connected to.

friendly_name

The human-readable name of the network to which the MCC-MNC values belong.

iso_country

The network's ISO2 country code.

sid

Error info properties

The event's error property will be null if no error occurred. Otherwise it contains the following information.

Property

Description

code

A KORE error code.

message


Tips and tricks

Start development with a Subaccount or a new Project

How to generate Attachment Rejected events

To generate attachment.rejected events, you can put a Super SIM that is either new or inactive into your device. Alternatively, update your Fleet's Network Access Profile to block all of the networks in your country.

Get your data usage from Data Session Ended events if you can

If you don't need to do near real-time usage billing or metering, you may be able to use data_session_data_upload, data_session_data_download, or data_session_data_total properties on data-session.ended events to understand how much data each of your devices are using without having to subscribe to data-session.updated events. These fields contain the cumulative amount of data exchanged by your device over the data session. This can reduce the number of events you have to receive and process by over 90%.

The network that your device is trying to connect to is allowed by the used by the Super SIM's Fleet.

If your device is using a valid Super SIM APN (e.g., super) and the device is able to establish a data connection, a event will follow this event. If you receive repeated attachment.accepted events in quick succession, it may indicate that the device is unable to use data and is repeatedly restarting the attachment process.

The network that your device is trying to connect to is blocked by the used by the Super SIM's Fleet.

Data session events will be published for traffic on both user APNs (e.g., super) and OTA APNs (e.g., ota.super) because all data used is billed and counts towards the Super SIM's data limit. However, data-session.started events will not indicate how much data was transferred by a device; this event only indicates that a data session has begun. To track data usage, subscribe to events.

While the device remains connected, data-session.updated events will be published approximately every six minutes, with the first arriving approximately six minutes after the event. Each data-session.updated event will include the number of bytes that were sent to the device (the event's data_download property) and the number sent by the device (data_upload) between the data_session_update_start_time and the data_session_update_end_time.

Your device's data session has ended. The device can no longer send or receive data until a new data session is started. This event will include the amount of data that was sent to the device (data_download) and from the device (data_upload) since the most recent event.

An object containing information about the location of the cell to which the device was connected. This may be null as location information is not guaranteed to be sent by the visited network. See for more details.

An object containing information about the network that the Super SIM attempted to connect to or is connected to. See for more details.

An object containing information about any error encountered. See for more details.

The SID of the representing the network.

A short message indicating why the error occurred. It may include standard [Diameter protocol]() error messages.

If you already have a number of devices deployed, you may quickly exceed the offered by Event Streams. For example, data-session.updated events are published every six minutes if your devices maintain a persistent connection, and can therefore exceed 7,000 events per device per month. We recommend you start your development work in a separate so you don't get charged for the events generated by all of your devices until you are ready.

You can transfer a Super SIM that is still in the new state to a subaccount by using . If you wish to transfer a Super SIM in another state to a different Account (either a Subaccount or a Project), please open a . A KORE Support Specialist will be able to help you get started.

Network Access Profile
Network Access Profile
first 100,000 free events
KORE Subaccount or Project
this API request
support ticket
Data Session Started
Data Session Updated
Data Session Started
Data Session Updated
Network resource
https://en.wikipedia.org/wiki/Diameter_(protocol\)
Location info properties
Network info properties
Error info properties
schema
Attachment Accepted
Attachment Rejected
Attachment Failed
Data Session Started
Data Session Updated
Data Session Ended
Data Session Failed