Skip to main content
Skip table of contents

Usage data streams (How To)

POSTData Stream Callback (UsageEvents)

https://api.sft.bics.com/#898d171e-6609-40da-9987-ff4daf1fed87

  • Data

  • SMS

Usage events - Data and SMS event details

File format

  • compressed '*.zip) txt with “;” as the seperator

  • all usage events are in the same file

File naming

  • <stream_Id>_usage_<timestamp>_<id>.<ext>

example: 2209_usage_20241028_0910_1.zip

Sample file

Field

Values for Data

Values for SMS

Valid for

Description

generationTimeStamp

Data and SMS

Datetime of the generated Event based on customer timezone.

callStartTimeUTC

Data

The callStartTimeUTC is the start time of the data session based on UTC timezone

callStopTimeUTC

Data

The callStopTimeUTC is the time of the last update (when quota was consumed or session ended/closed) based on UTC timezone.

callStartTime

Data

Start datetime of the data session based on customer timezone.

callStopTime

Data

The callStopTime is the time of the last update (when quota was consumed or session ended/closed) based on customer timezone.

aParty

Data and SMS

MSISDN of the Endpoint

callCharge

Data and SMS

Charge of the usage in 1/100th of the unit (cents in case of EURO)

locationInfo

Data

Gives the location of the visited network (6 digit format)
Data: MCC/MNCof the visited network
SMS: MCC/MNC of the network where the SMS was originated

imsi

Data and SMS

IMSI of the Endpoint

planId

Data and SMS

Provides the Plan Id of the Endpoint

volumeAccumulated

Data

Consumed Volume of the transaction

accessFlag

Data and SMS

Indicates the type of service
2 - for Data
6 - for SMS
124 - NB-IOT

comments

Data and SMS

Comments for this usage event

ratingGroup1

Data

Rating Group Id,
2 – RG-OTA
3 – RG-Redirect
5 – RG-Online
Note: ratingGroup1 will be empty for SMS usage

tariffInfo

Data and SMS

For Data usage this is the unique tariff Id along with zero appended ie "Tariffid-0".
For SMS usage this is the unique tariff Id along with PPU(price per unit) and Pulse ie "Tariffid-PPU-PULSE".

origCountry

Data and SMS

Originating country ID
Use "Get Countries" API to retrieve the Country Id list.

iccid

Data and SMS

ICCID of the Endpoint

imei

Data

IMEI of the Device

bparty

SMS

bparty number

rateZoneId

Data and SMS

Ratezone Id of the account

parentEntityName

Data and SMS

Name of the customer in the platform

apn

Data

APN used for the specific transaction

planStartDate

Data

The start date of the addon Plan that was used.

planExpiryDate

Data

The End date of the addon Plan that was used.

uniqueId

Data

The unique id of the addon Plan that was used.

chargingId

Data

The ID (unique) of the data session,. It remains constant for all transactions under the same session.
Can be used to identify all the transactions under one specific data session.

ccRequestNumber

Data

The sequence number of the transaction within a data session. It is unique for the specific session.
Starts with 0 and its is autoincrement for each transacition.

ratType

Data

Service Profile Access Type (RAT Type)
01 – 2G/3G
02 – 2G
06 - 2G/3G/4G
08 - NB-IoT

origOperatorPLMN

Data and SMS

Tadig of the visited operator

accountId

Data and SMS

Account Id of the Endpoint (Endpoint ID)

parentAccountId

Data and SMS

Account ID of the immediate parent

supplierName

Data

It describes which IMSI (Sponsor) was used by the endpoint when the event was generated

iPAddress

Data

The IP address of the device

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.