Streaming Telemetry
Customers with wholesale mobile network connectivity or retail services via KeySIM are able to access real-time telemetry about their SIM estate. We provide this data over the Internet of Things industry standard message broker protocol MQTT.
MQTT Broker
- Server
- telemetry.keysim.network
- Port
- 1883 (TLS)
8883 (TLS)
8443 (websocket) - Username
- (available from the KeySIM Portal)
- Password
- (available from the KeySIM Portal)
RADIUS-MQTT Topics
Our mobile network carrier RADIUS servers send through RADIUS accounting messages to our central MQTT broker service.
- keysim/user@keysim.network/iccid/Start
- Connection established
- keysim/user@keysim.network/iccid/Stop
- Connection terminated
- keysim/user@keysim.network/iccid/Interim-Update
- Periodic usage report
- keysim/user@keysim.network/iccid/Control
- Automation (writeable)
- keysim/user@keysim.network/iccid/Return
- Automation responses
Message Format
The body of the message will be posted as a UTF-8 JSON-encoded payload. If multiple AV pairs exist with the same attribute name, then the value will be encoded as a list.
Common Attributes
These attributes are mapped to dictionary keys in all RADIUS accounting messages.
- ICCID
- The SIM chip number, e.g. 89462038005001234567.
- 3GPP-IMSI
- IMSI, e.g. 240075812345678.
- Calling-Station-Id
- MSISDN, e.g. 467191202345678.
- 3GPP-IMEISV
- Device IMEI and software version (last two digits), e.g. 8636640351234567.
- Event-Timestamp
- RFC822-formatted timestamp from mobile network, e.g. Aug 20 2021 06:12:58 UTC.
- Time
- UNIX timestamp from RADIUS server, e.g. 1629439978.719206.
- Acct-Status-Type
- Will be one of Start, Stop, or Interim-Update.
- 3GPP-GGSN-MCC-MNC
- MCC-MNC of the network to which the GGSN belongs, e.g. 24007.
- 3GPP-SGSN-MCC-MNC
- MCC-MNC of the network to which the SGSN belongs, i.e. current network the SIM is attached to, e.g. 23415.
Addressing
This set of attributes is related to the IP addressing associated with the PPP user and current session.
- Framed-IP-Address
- IPv4 address of the client device.
- Called-Station-Id
- APN, will normally be Key.
Interim Updates
Approximately every five minutes an “Interim-Update” will be sent through containing the following attributes. The “Stop” message at the end of the session will also include this data.
- Acct-Input-Octets
- Total number of bytes received from the client during this session. 64-bit number.
- Acct-Output-Octets
- Total number of bytes send to the client during this session. 64-bit number.
Automation
Publishing messages to the keysim/user@keysim.network/iccid/Control topic provides identical functionality to KeySIM’s internal APIs. Control messages should be UTF-8 JSON-encoded payloads.
Return
Responses to Control messages will be posted back to keysim/user@keysim.network/iccid/Return and will include the original control message, so callers can add a unique token to the Control request if required. Responses will be UTF-8 JSON-encoded payloads with success set to true:
{ "success": true }
Or should they fail then success will be false and an error string returned:
{ "success": false, "error": "This is not one of your SIMs." }
Activating a SIM
{ "active": true }
Deactivating a SIM
{ "active": false }
Steering a SIM
{ "active": true, "plan": "GroupA" }
Available Plans
- UK4
- All four UK networks. Unsteered.
- UK3+EU2
- Some UK and some EU networks. Unsteered.
- Global
- Global, data costs are much higher! Unsteered.
- UK4IoT
- Lower monthly cost, but higher data charges apply! Unsteered.
- GroupA
- EE (UK), Orange (FR), Vodafone (DE), Sunrise (CH), Vodafone (NL)…
- GroupB
- Vodafone (UK), Bouygues (FR), Telefonica (DE), Swisscom (CH), T-Mobile (NL)…
- GroupC
- Three (UK), SFR (FR), T-Mobile (DE), Salt (CH), KPN (NL)…
- GroupD
- O2 (UK), Free (FR)…