Sigfox message info

Use these API endpoints to read message metadata, like signal strength and the active node configuration.

Current version: 1

Example message info

{
  "sigfox_message": {
    "id": "Abc123",
    "sent_at": "2021-01-01T13:00:00.000+01:00",
    "created_at": "2021-01-01T13:00:00.000+01:00",
    "recorded_at": "2021-01-01T13:00:00.000+01:00",
    "snr": 1.234,
    "rssi": 1.234,
    "sequence": 123,
    "message_number": 123,
    "external_io": 1,
    "processing_error": "Processing Error",
    "node": {
      "id": "Ref001",
      "sigfox_id": "123ABC"
    },
    "node_configuration": {
      "id": "Ref001",
      "name": "Name",
      "behavior_id": "Abc123",
      "behavior_version": 3,
      "behavior_profile": "unless",
      "trigger_type": "motion"
    }
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<sigfox-message>
  <id>Abc123</id>
  <sent-at type="dateTime">2021-01-01T13:00:00+01:00</sent-at>
  <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
  <recorded-at type="dateTime">2021-01-01T13:00:00+01:00</recorded-at>
  <snr type="float">1.234</snr>
  <rssi type="float">1.234</rssi>
  <sequence type="integer">123</sequence>
  <message-number type="integer">123</message-number>
  <external-io type="integer">1</external-io>
  <processing-error>Processing Error</processing-error>
  <node>
    <id>Ref001</id>
    <sigfox-id>123ABC</sigfox-id>
  </node>
  <node-configuration>
    <id>Ref001</id>
    <name>Name</name>
    <behavior-id>Abc123</behavior-id>
    <behavior-version type="integer">3</behavior-version>
    <behavior-profile type="symbol">unless</behavior-profile>
    <trigger-type type="symbol">motion</trigger-type>
  </node-configuration>
</sigfox-message>
recorded_at When the data was recorded by the node. This field can be null for acknowledgement messages or if the data could not be parsed.
sent_at When the message was sent by the node.
(Please note: If a message is being sent again, the sent_at will contain the timestamp for when the message was sent again, not the original timestamp)
snr The signal-to-noise ratio in dB.
rssi The received signal strength indicator in dBm.
sequence The Sigfox sequence number of the message.
message_number The Bumblebee sequence number of the message. This field can be null for acknowledgement messages or if the data could not be parsed.
external_io The state of the external i/o at the time of the message. A value of 0 means the external i/o is active, a value of 1 means the external i/o is inactive. This value will be nil for acknowledgement messages, if the data could not be parsed, or if the node version is below 0.9
created_at When we received this message from Sigfox.
processing_error Errors occured during the processing of the message. Omitted when empty.
node The node this message belongs to.
node/id The id of the node.
node_configuration The node-configuration that was active at the time the message was recorded.
This can differ from the configuration that is assigned to the asset if the node has not received the latest configuration changes yet. This node can be null for acknowledgement messages or if the data could not be parsed.
node_configuration/id The id of the configuration.
node_configuration/name The name of the configuration.
node_configuration/behavior_id The ID of the behavior that was active.
node_configuration/behavior_version The version of the behavior that was active. The version will change every time you alter the behavior.
node_configuration/behavior_profile The profile of the behavior that was active, the value is one of: default or unless.
node_configuration/trigger_type The type of trigger that caused this message to be sent, only present if behavior_profile is unless.

Index

Gets a list with all Sigfox messages for your nodes. This is a paginated response.

URL
GET https://my.iobee.eu/api/sigfox_messages

Response

Status
200 - OK
Body
{
  "sigfox_messages": [
    {
      "id": "Abc123",
      "sent_at": "2021-01-01T13:00:00.000+01:00",
      "created_at": "2021-01-01T13:00:00.000+01:00",
      "recorded_at": "2021-01-01T13:00:00.000+01:00",
      "snr": 1.234,
      "rssi": 1.234,
      "sequence": 123,
      "message_number": 123,
      "external_io": 1,
      "processing_error": "Processing Error",
      "node": {
        "id": "Ref001",
        "sigfox_id": "123ABC"
      }
    }
  ],
  "_next_page": {
    "token": "eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9",
    "empty": true,
    "remaining": 0,
    "url": "https://my.iobee.eu/docs/api/sigfox_messages?page_token=eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<hash>
  <sigfox-messages type="array">
    <sigfox-message>
      <id>Abc123</id>
      <sent-at type="dateTime">2021-01-01T13:00:00+01:00</sent-at>
      <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
      <recorded-at type="dateTime">2021-01-01T13:00:00+01:00</recorded-at>
      <snr type="float">1.234</snr>
      <rssi type="float">1.234</rssi>
      <sequence type="integer">123</sequence>
      <message-number type="integer">123</message-number>
      <external-io type="integer">1</external-io>
      <processing-error>Processing Error</processing-error>
      <node>
        <id>Ref001</id>
        <sigfox-id>123ABC</sigfox-id>
      </node>
    </sigfox-message>
  </sigfox-messages>
  <_next-page>
    <token>eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9</token>
    <empty type="boolean">true</empty>
    <remaining type="integer">0</remaining>
    <url>https://my.iobee.eu/docs/api/sigfox_messages?page_token=eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9</url>
  </_next-page>
</hash>

Show

Gets the specified message info.

URL
GET https://my.iobee.eu/api/sigfox_messages/:id

Response

Status
200 - OK
Body
{
  "sigfox_message": {
    "id": "Abc123",
    "sent_at": "2021-01-01T13:00:00.000+01:00",
    "created_at": "2021-01-01T13:00:00.000+01:00",
    "recorded_at": "2021-01-01T13:00:00.000+01:00",
    "snr": 1.234,
    "rssi": 1.234,
    "sequence": 123,
    "message_number": 123,
    "external_io": 1,
    "processing_error": "Processing Error",
    "node": {
      "id": "Ref001",
      "sigfox_id": "123ABC"
    },
    "node_configuration": {
      "id": "Ref001",
      "name": "Name",
      "behavior_id": "Abc123",
      "behavior_version": 3,
      "behavior_profile": "unless",
      "trigger_type": "motion"
    }
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<sigfox-message>
  <id>Abc123</id>
  <sent-at type="dateTime">2021-01-01T13:00:00+01:00</sent-at>
  <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
  <recorded-at type="dateTime">2021-01-01T13:00:00+01:00</recorded-at>
  <snr type="float">1.234</snr>
  <rssi type="float">1.234</rssi>
  <sequence type="integer">123</sequence>
  <message-number type="integer">123</message-number>
  <external-io type="integer">1</external-io>
  <processing-error>Processing Error</processing-error>
  <node>
    <id>Ref001</id>
    <sigfox-id>123ABC</sigfox-id>
  </node>
  <node-configuration>
    <id>Ref001</id>
    <name>Name</name>
    <behavior-id>Abc123</behavior-id>
    <behavior-version type="integer">3</behavior-version>
    <behavior-profile type="symbol">unless</behavior-profile>
    <trigger-type type="symbol">motion</trigger-type>
  </node-configuration>
</sigfox-message>

Message info history

Gets the message info history of a node. This is a paginated response.

URL
GET https://my.iobee.eu/api/nodes/:id/sigfox_messages

Response

Status
200 - OK
Body
{
  "sigfox_messages": [
    {
      "id": "Abc123",
      "sent_at": "2021-01-01T13:00:00.000+01:00",
      "created_at": "2021-01-01T13:00:00.000+01:00",
      "recorded_at": "2021-01-01T13:00:00.000+01:00",
      "snr": 1.234,
      "rssi": 1.234,
      "sequence": 123,
      "message_number": 123,
      "external_io": 1,
      "processing_error": "Processing Error"
    }
  ],
  "_next_page": {
    "token": "eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9",
    "empty": true,
    "remaining": 0,
    "url": "https://my.iobee.eu/docs/api/sigfox_messages?page_token=eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<hash>
  <sigfox-messages type="array">
    <sigfox-message>
      <id>Abc123</id>
      <sent-at type="dateTime">2021-01-01T13:00:00+01:00</sent-at>
      <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
      <recorded-at type="dateTime">2021-01-01T13:00:00+01:00</recorded-at>
      <snr type="float">1.234</snr>
      <rssi type="float">1.234</rssi>
      <sequence type="integer">123</sequence>
      <message-number type="integer">123</message-number>
      <external-io type="integer">1</external-io>
      <processing-error>Processing Error</processing-error>
    </sigfox-message>
  </sigfox-messages>
  <_next-page>
    <token>eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9</token>
    <empty type="boolean">true</empty>
    <remaining type="integer">0</remaining>
    <url>https://my.iobee.eu/docs/api/sigfox_messages?page_token=eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9</url>
  </_next-page>
</hash>

Options

Include node configuration

?include_node_configuration=t

You can request to receive the configuration that was used by the node to sent the message. If this option is set to true in index or message info history, Bumblebee will include a node_configuration node. Note that in show this option is automatically set to true.