Receiving Radius Accounting push messages

Eseye sends customer-specific Radius Accounting data as raw push messages to subscribed customers. Each record appears in the format described below.

Raw push message/json

Schema

Object name Type Description
acctStartDateTime DateTime

Date and time the session started.

UTC format: YYYY-MM-DDThh:mm:ss.ssssss, where T is the time separator.
acctStopCause string

The reason the session terminated:

Code Termination cause Description
1 User request User initiated the termination by logging off.
2 Lost Carrier The port or modem dropped the Data Carrier Detect (DCD) signal.
3 Lost Service The service is unavailable for continued provision. Connection interruptions are the most likely cause.
4 Idle Timeout The idle timer expired for the user or port.
5 Session Timeout The subscriber reached the maximum continuous time limit allowed for the service or session.
6 Admin Reset The system administrator reset the port or session.
7 Admin Reboot The system administrator reset the hardware required to continue the connection, for example, by rebooting the Network Access Server (NAS).
8 Port Error The NAS detected an error on the port, which required ending the session.
9 NAS Error The NAS detected an error (other than on the port), which required ending the session.
10 NAS Request The NAS ended the session for a non-error reason.
11 NAS Reboot The NAS ended the session unexpectedly to reboot.
12 Port Unneeded The NAS ended the session because the resource usage was beneath the low threshold. For example, the bandwidth-on-demand algorithm determined that the port was no longer needed.
13 Port Preempted The NAS ended the session to allocate the port for higher-priority use.
14 Port Suspended The NAS ended the session to suspend a virtual session.
15 Service Unavailable The NAS was unable to provide the requested service.
16 Callback The NAS ended the session in order to perform callback for a new session.
17 User Error A client input error ended the session.
18 Host Request The login host ended the session. While this usually indicates normal termination of a login session, the remote host may have failed or become unreachable.
acctStopDateTime DateTime

Date and time the session ended. "" indicates the session is ongoing and has not ended.

UTC format: YYYY-MM-DDThh:mm:ss.ssssss, where T is the time separator.
acctType string

There are three accounting types, indicating the session state on the network:

AccountingStart – when the session starts with an authentication request.

AccountingInterim – when the network operator sends updates, such as session length, number of bytes and so on. The first interim request is usually sent 30 minutes after a start request. You may observe multiple AccountingInterim accounting types, or none at all, depending on the session length.

AccountingStop – when the device disconnects from the network.

You can subscribe to one or more accounting types.

apn string The Access Point Name the device used to access the IP network.
bytes string The total amount of data sent and received by the device during the reported session, in bytes.
eventDateTime DateTime

Date and time the data capture started.

UTC format: YYYY-MM-DDThh:mm:ss.ssssss, where T is the time separator.
expiryDateTime DateTime

The timeout value configured for the Radius Accounting cache by the network.

UTC format: YYYY-MM-DDThh:mm:ss.ssssss, where T is the time separator.
iccId string The unique Integrated Circuit Card Identifier of the specific SIM used by the device.
imsi string

The unique International Mobile Subscriber Identity number that identifies a cellular network subscriber. The network operator that provided the IMSI uses it to authenticate a SIM (and the IoT device containing the SIM) on the network.

inputOctets string The total amount of data received in sets of eight bits by the device during the reported session.
ip string The assigned IP address.
mccmnc string

The MCC and MNC, concatenated:

Mobile Country Code – identifies the country of the cellular tower to which the SIM last connected, in three-digit numeric format. For more information, see Mobile country codes.

Mobile Network Code – identifies the network operator of the network to which the SIM last subscribed, in two-digit numeric format. For more information, see: Mobile network codes listed by country.
messageSequenceNumber string A network-generated unique reference for the payload.
mnoId string The Mobile Network Operator Identifier.
msisdn string The unique primary SIM phone number (Mobile Station International ISDN Number).
notificationClass string

The data class, to differentiate between the types of data pushed by the Push API. These are netflow, radiusauth and radiusacct.
outputOctets string The total amount of data sent in sets of eight bits by the device during the reported session.
payload array The array, listing the network data for an individual device.
portfolioId string The SIAM account portfolio identifier. Contains exactly 32 characters.
simId string The SIM's unique serial number.
userName string The login user who started the session.

Example

Copy
Body raw JSON
{ 
  "payload": { 
    "iccId": "8944538523001234567", 
    "simId": "5170000201264588", 
    "imsi": 234588558496446, 
    "msisdn": 111111111111, 
    "mnoid": "350", 
    "mccmnc": "23415", 
    "apn": "eseye.com", 
    "userName": "user@eseye.com ", 
    "acctStartDateTime": "2021-03-02T12:48:46.050316", 
    "acctStopDateTime": "", 
    "ip": "10.34.38.238", 
    "acctType": "AccountingInterim", 
    "acctStopCause": "", 
    "bytes": 1319137, 
    "inputOctets": 804669, 
    "outputOctets": 514468 
  }, 
  "portfolioId": "000459cb1f57e1be0099c533687e68cc", 
  "notificationClass": "radiusacct", 
  "eventDateTime": "2021-03-02T12:48:46.050316", 
  "expiryDateTime": "2021-03-03T12:48:46.050333", 
  "messageSequenceNumber": "67f93a41-1c90-4691-a10f-01772e264f79" 
} 

Where to next?

Related resources