Skip to main content
Skip table of contents

Mobility event data streams (How To)

POSTData Stream Callback (MobilityEvents)

https://api.sft.bics.com/#f8c1ec70-1a57-434d-a343-dc744523bd6f

Mobility events are generated by an endpoint/SIM while it tries to use any of the services from the SFT platform, these are also sometimes referred to as network events.

These individual events have been categorised into groups/categories:

CODE 
Authentication
        Authentication failure report
        Authentication information request
        Send authentication info
Cancel Location
        Cancel Location
        Cancel location request 4G
Data Session
        Create PDP
        Delete PDP
Purge Subscriber
        Purge Mobile Subscriber
        Purge UE Request 4G
SMS
        SMS-MO
        Alert Service Center
        Ready for short message
        Report short message delivery status
Update Location
        Update location GPRS
        Update location GSM
        Update location request 4G

For more details about individual mobility events, check the table below:

Category

Mobility Event

Access Type

Description

Authentication

Authentication Information Request

4G

The device initiates a process which will allow the network and the SIM card to authenticate each other.

Send Authentication Info

2G/3G

The device initiates a process which will allow the network and the SIM card to authenticate each other.

Authentication failure report

ALL

The SIM doesn’t manage to get authenticated. This can happen because of a series of reasons, usually, either the authentication keys or the corresponding algorithm parameters are wrong or the SIM has the wrong Sequence Number. Unlike the first two cases, the latter will be resolved by itself after an automatic synchronization between the SIM and the HSS.

Cancel Location

Cancel Location

2G/3G

The device has attached to a node in the visited network which is different from the one it was attached to before. HSS simply informs the previous node that the device is no longer there.

Cancel Location request 4G 

4G

The device has attached to a node in the visited network which is different from the one it was attached to before. HSS simply informs the previous node that the device is no longer there.

Data Session

Create PDP

ALL

The device is creating a new data session.

Delete PDP

ALL

The ongoing data session has been stopped.

Purge Subscriber

Purge Mobile Subscriber

2G/3G

The visited network keeps some data related to the subscriber during a period of time after the device is detached from the network. When that period of time is elapsed, the visited network deletes that data and informs the HSS that the device is no longer there by means of this message.

Purge UE Request 4G

4G

If a purge comes right after an Update Location request 4G with no Create PDP, this normally means that no data session could be established. One device cannot be attached to 4G without having an active data session. Hence, if the data session could not be established -e.g. because wrong APN is configured- the 4G node of the visited network will inform the HSS that the device is no longer attached to it. When the Purge is not immediately preceded by an Update Location Request, then, the event is the same as Purge Mobile Subscriber in 2G/3G.

SMS

SMS-MO

ALL

The subscriber has sent an SMS.

Report Short Message Delivery status

ALL

Upon device’s request, the SMSC may inform A-party about whether the message was successfully delivered to the B-Party or not.

Ready for Short Message

ALL

An SMS was sent to a device but the visited network could not reach it. As soon as the device shows some activity in that node, this one informs the home network (HSS) that the B-Party should be ready to receive that SMS.

Alert Service Centre

ALL

Upon reception of a Ready for Short Message event from visited network, HSS informs the corresponding SMSC that the device should now be reachable so that SMSC sends the SMS again.

Update Location

Update Location GPRS

2G/3G

After successfully completing the Authentication process, the device needs to attach to the Data core network in order to be able to establish a data session in 2G/3G. During the Location Update procedure, the HSS will inform the visited network if the device is allowed to attach to that network, which APNs to use, with which QoS, etc.

Update Location Request 4G

4G

After successfully completing the Authentication process, the device needs to attach to the Data core network in order to be able to establish a data session in 4G. During the Location Update procedure, the HSS will inform the visited network if the device is allowed to attach to that network, which APNs to use, with which QoS, etc.

Update Location GSM

2G/3G

After successfully completing the Authentication process, the device needs to attach to the Voice core network in order to be able to send and receive SMSs. During the Location Update procedure, the HSS will inform the visited network if the device is allowed to attach to that network and with which services. If the device is attached to a 4G network and if device needs SMS services, the 4G node will initiate the GSM Location Update towards the voice core network on device’s behalf.

Mobility events are transferred either in a zipped txt file or through callback API, both of the delivery mechanism have similar information about the events. Every entry in the file or API will have the same fields for each event.

For details description of each field in the event check the table below.

Position

Field

Description

1

country

Visited country name.

2

endUserAccountID

Endpoint ID.

3

serialNumber

Sequence number of the event (auto incrementing).

4

endUserAccountName

Endpoint Name.

5

errorDescription

Text description of error received.

6

accountName

Name of the account.

7

tadig

TADIG of the visited network. (TADIG is a code uniquely identifying network operators in a GSM mobile network).

8

errorCode

Code of error received.

9

imsi

IMSI used by SIM to connect in the visited network.

10

operatorName

Name of the visited network operator.

11

result

Result of the operation.

12

accountID

Id of account.

13

errorCause

Cause of the error received.

14

iccid

ICCID of the SIM card.

15

remoteNodeType

Visited network node sending the response for e.g. VLR, MME etc.

16

msisdn

MSISDN of the SIM card.

17

networkType

Access type of the network for e.g 2G, 3G, 4G etc.

18

operation

Operation name (Mobility event name).

19

operatorID

ID of the visited network in SFT platform.

20

remoteNodeHost

Visited network host name.

21

timestamp

Timestamp of the event (in UTC format)

22

remoteNodeGT

Visited network global title.

23

remoteNodeRealm

Visited network realm name.

Some fields might be left empty if this event information is not received from the visited network.

For the details of which fields will be received and which fields will be left empty for each event, check the table below.

Operation

country

endUserAccountID

serialNumber

endUserAccountName

errorDescription

accountName

tadig

errorCode

imsi

operatorName

result

accountID

errorCause

iccid

remoteNodeType

msisdn

networkType

operatorID

remoteNodeHost

timestamp

remoteNodeGT

remoteNodeRealm

Authentication Information Request

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

Send Authentication Info

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Authentication failure report

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

Cancel Location

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Cancel Location request 4G 

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

Create PDP

YES

YES

YES

YES

YES

YES

NO

NO

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

NO

YES

NO

NO

Delete PDP

YES

YES

YES

YES

YES

YES

NO

NO

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

NO

YES

NO

NO

Purge Mobile Subscriber

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Purge UE Request 4G

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

SMS-MO

YES

YES

YES

YES

YES

YES

NO

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Report Short Message Delivery status

YES

YES

YES

YES

YES

YES

NO

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Ready for Short Message

YES

YES

YES

YES

YES

YES

NO

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Alert Service Centre

YES

YES

YES

YES

YES

YES

NO

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Update Location GPRS

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

Update Location Request 4G

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

Update Location GSM

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

YES

YES

YES

YES

YES

YES

YES

YES

NO

YES

YES

NO

JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close