POST api/v1/thethingsnetwork/v3/uplink

Upload data from The Things Network HTTP Integration V3.

Request Information

URI Parameters

None.

Body Parameters

UplinkMessageV3Dto
NameDescriptionTypeAdditional information
end_device_ids

EndDeviceIds

None.

correlation_ids

Correlation identifiers of the message

Collection of string

None.

received_at

ISO 8601 UTC timestamp at which the message has been received by the Application Server

date

None.

uplink_message

UplinkMessage

None.

simulated

Signals if the message is coming from the Network Server or is simulated.

boolean

None.

Request Formats

application/json, text/json, application/senml+json

Sample:
{
  "end_device_ids": {
    "device_id": "sample string 1",
    "application_ids": {
      "application_id": "sample string 1"
    },
    "dev_eui": "sample string 2",
    "join_eui": "sample string 3",
    "dev_addr": "sample string 4"
  },
  "correlation_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "received_at": "2024-04-12T05:50:55.056464+00:00",
  "uplink_message": {
    "session_key_id": "sample string 1",
    "f_port": 2,
    "f_cnt": 3,
    "frm_payload": "sample string 4",
    "decoded_payload": null,
    "decoded_payload_warnings": null,
    "rx_metadata": [
      {
        "gateway_ids": {
          "gateway_id": "sample string 1",
          "eui": "sample string 2"
        },
        "packet_broker": {
          "message_id": "sample string 1",
          "forwarder_net_id": "sample string 2",
          "forwarder_tenant_id": "sample string 3",
          "forwarder_cluster_id": "sample string 4",
          "forwarder_gateway_eui": "sample string 5",
          "forwarder_gateway_id": "sample string 6",
          "home_network_net_id": "sample string 7",
          "home_network_tenant_id": "sample string 8",
          "home_network_cluster_id": "sample string 9"
        },
        "time": "2024-04-12T05:50:55.056464+00:00",
        "timestamp": 2,
        "rssi": 3.1,
        "signal_rssi": 4.1,
        "channel_rssi": 5.1,
        "channel_index": 6,
        "snr": 7.1,
        "frequency_offset": "sample string 8",
        "uplink_token": "sample string 9",
        "location": {
          "latitude": 1.1,
          "longitude": 1.1,
          "altitude": 1.1,
          "source": "sample string 1"
        }
      },
      {
        "gateway_ids": {
          "gateway_id": "sample string 1",
          "eui": "sample string 2"
        },
        "packet_broker": {
          "message_id": "sample string 1",
          "forwarder_net_id": "sample string 2",
          "forwarder_tenant_id": "sample string 3",
          "forwarder_cluster_id": "sample string 4",
          "forwarder_gateway_eui": "sample string 5",
          "forwarder_gateway_id": "sample string 6",
          "home_network_net_id": "sample string 7",
          "home_network_tenant_id": "sample string 8",
          "home_network_cluster_id": "sample string 9"
        },
        "time": "2024-04-12T05:50:55.056464+00:00",
        "timestamp": 2,
        "rssi": 3.1,
        "signal_rssi": 4.1,
        "channel_rssi": 5.1,
        "channel_index": 6,
        "snr": 7.1,
        "frequency_offset": "sample string 8",
        "uplink_token": "sample string 9",
        "location": {
          "latitude": 1.1,
          "longitude": 1.1,
          "altitude": 1.1,
          "source": "sample string 1"
        }
      }
    ],
    "settings": {
      "data_rate": {
        "lora": {
          "bandwidth": 1,
          "spreading_factor": 2
        }
      },
      "data_rate_index": 1,
      "coding_rate": "sample string 2",
      "frequency": "sample string 3"
    },
    "received_at": "2024-04-12T05:50:55.056464+00:00",
    "consumed_airtime": "sample string 6",
    "network_ids": {
      "net_id": "sample string 1",
      "tenant_id": "sample string 2",
      "cluster_id": "sample string 3"
    },
    "locations": {
      "user": {
        "latitude": 1.1,
        "longitude": 1.1,
        "altitude": 1.1,
        "source": "sample string 1"
      }
    }
  },
  "simulated": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/senml+json

Sample:

Sample not available.