Helpful

CallbacksService callback

Data advanced

The Service > Data Advanced callback is delivered with an approximate 30 seconds delay. The content of the variables marked as objects cannot be edited. The system will insert a set of JSON variables in place of these objects, using a predefined format.

(warning) Please scroll down to the bottom of this article to find examples of said JSON format.

VariableTypeFormat

Description

device

stringin hexadecimal, up to 8 characters

Device identifier (in hexadecimal – up to 8 characters <=> 4 bytes)

time

integerEpoch time in seconds

the GMT timestamp corresponding to the message reception time

data 

stringHexadecimal

the user data (in hexadecimal)

seqNumber

integer

the sequence number of the message

lqi

string

the computed link quality with following values

  • "LIMIT"
  • "AVERAGE"
  • "GOOD"
  • "EXCELLENT"
  • "NA"
linkQualityinteger

integer value corresponding to the lqi string value

  • 0 = "LIMIT"
  • 1 = "AVERAGE"
  • 2 = "GOOD"
  • 3 = "EXCELLENT"
  • 4 = "NA"

fixedLat 

float

the fixed latitude set in the device setting page

fixedLng

float

the fixed longitude set in the device setting page

operatorName

string

the name of the operator who received the message

countryCode

integer

the country code of the operator who received the message

duplicates

object "Duplicates"

the list of the duplicates with the base station ids, the number of repetitions, the SNR and the RSSI

Condition: for devices with contract option NETWORK METADATA

duplicates.bsIdstringhexadecimal

id of the base station

Condition: for devices with contract option NETWORK METADATA

duplicates.nbRepinteger

number of repetitions received

Condition: for devices with contract option NETWORK METADATA

duplicates.rssifloat

the best signal to noise ratio of the received repetitions

Condition: for devices with contract option NETWORK METADATA

computedLocationobject "computedLocation"

the device location computed by the location service

Condition: for devices with contract option ATLAS service

computedLocation.latfloat

the estimated latitude of the device

Condition: for devices with contract option ATLAS service

computedLocation.lngfloat

the estimated longitude of the device

Condition: for devices with contract option ATLAS service

computedLocation.radiusinteger

radius limit in meters that defines the zone in which the device is located.

Condition: for devices with contract option ATLAS service

computedLocation.sourceinteger
  • 1 : using the GPS data inside the payload
  • 2 : by Network location
  • 6 : by WiFi location (External Provider)

 source from which the geolocation has been computed

Condition: for devices with contract option ATLAS service

computedLocation.statusinteger
  • 00: No position
  • 01: OK
  • 02: Fallback of WiFi location
  • 20: Invalid payload

status of the computation made by the location service

Condition: for devices with contract option ATLAS service

Sigfox backend JSON body format example:

{

"deviceId":"{deviceId}",

"data": "{data}",

"computedLocation": {computedLocation},

"duplicates": {duplicates}

}

Corresponding example of JSON body received by target server:

{

"deviceId":"123abc",

"data": "1234567890abcdef1a2b3c4d",

"computedLocation": 

{
        "lat":0.0,
        "lng":0.0,
        "radius":0,
        "source":2,
        "status":0
},

"duplicates": [
{
        "bsId":"0001",
        "nbRep":1,
        "snr":0.0,
        "rssi":0.0
 }
 ]

}

   

Can't find what you're looking for ?

Have questions? Our worldwide Community of expert fans can answer them.
Have answers? Join the Community and help!

slack logo

Ask the community >