リファレンス: SORACOM Funnel から送信されるデータフォーマット | SORACOM Funnel

転送先サービスには、以下のようなフォーマットのデータが送信されます。

{
  "credentialId": "ソラコムの認証情報の ID",
  "operatorid": "ソラコムのアカウント ID",
  "destination": {
    "provider": "(aws|azure|google)",
    "service": "(aws-iot|kinesis|firehose|eventhubs|pubsub)",
    "resourceUrl": "転送先サービスの URL",
    "payloadsOnly": false,
    "sendPayloadsAsBinary": (true|false)
  },
  "sourceProtocol": "(tcp|udp|http|sigfox|lora|unspecified)",
  "payloads": "送信されたデータ本体",
  "timestamp": "Funnel でデータを処理した日時 (UNIX 時間)",
  "imsi": "送信元の SIM の IMSI",
  "imei": "送信元デバイスの IMEI"
}

Funnel が対応する TLS バージョンは 1.2 です

転送先サービスでは、TLS 1.2 に対応するように設定してください。たとえば、AWS IoT Core に送信する場合は、AWS IoT Core の [セキュリティポリシーを選択] では、TLS 1.2 に対応するセキュリティポリシーを選択してください。たとえば、「IoTSecurityPolicy_TLS13_1_2_2022_10」は TLS 1.2 に対応しています。

payloads 以外の値が送信されないように設定できます

[ペイロードのみ転送する] を ON に設定すると、payloads に設定されるデータだけが送信されます。payloads 以外の値 (credentialId など) は送信されません。

[送信データ形式] が「JSON」で、[ペイロードのみ転送する] が OFF の場合:

{
  "credentialsId": "AWS-IAM-role-credentials",
  "operatorId": "OPxxxxxxxxxx",
  "destination": {
    "provider": "aws",
    "service": "aws-iot",
    "resourceUrl": "xxxxx-ats.iot.ap-northeast-1.amazonaws.com/myTopic/#{imsi}",
    "payloadsOnly": false,
    "sendPayloadsAsBinary": false
  },
  "sourceProtocol": "http",
  "payloads": {
    "deviceid": "iot123",
    "temp": 54.98,
    "humidity": 32.43,
    "coords": {
      "latitude": 47.615694,
      "longitude": -122.3359976
    }
  },
  "timestamp": 1653891795421,
  "imsi": "2950xxxxxxxxxxx",
  "imei": "8676xxxxxxxxxxx"
}

[送信データ形式] が「JSON」で、[ペイロードのみ転送する] が ON の場合:

{
  "deviceid": "iot123",
  "temp": 54.98,
  "humidity": 32.43,
  "coords": {
    "latitude": 47.615694,
    "longitude": -122.3359976
  }
}

payloads に設定されるデータ

payloads に設定されるデータは、[送信データ形式] の設定によって異なります。

デバイスでのコマンド例:

curl -v funnel.soracom.io \
-H "Content-Type: application/json" \
-d '{
  "deviceid": "iot123",
  "temp": 54.98,
  "humidity": 32.43,
  "coords": {
    "latitude": 47.615694,
    "longitude": -122.3359976
  }
}'

上記のコマンドを実行して Funnel にデータを送信した場合に、payloads に設定されるデータは、以下のとおりです。

[送信データ形式] の設定	説明
(指定しない)	Funnel のエントリポイントの種類によって、データの処理が異なります。 UDP: テキストデータとして処理されます。 TCP: テキストデータとして処理されます。 HTTP: HTTP ヘッダーの `Content-Type` に従って処理されます。(*1) SMS: テキストデータとして処理されます。 USSD: テキストデータとして処理されます。 Air for LoRaWAN、Air for Sigfox、Inventory: テキストデータとして処理されます。
JSON	Funnel のエントリポイントの種類に関わらず、JSON 形式のデータとして処理されます。 `{ : "payloads": { "deviceid": "iot123", "temp": 54.98, "humidity": 32.43, "coords": { "latitude": 47.615694, "longitude": -122.3359976 } }, : }` デバイスが、JSON 形式以外のデータを送信した場合は、`400 Bad Request` が返されます。
テキスト	Funnel のエントリポイントの種類に関わらず、テキストデータとして処理されます。 `{ : "payloads": "{\n \"deviceid\": \"iot123\",\n \"temp\": 54.98,\n \"humidity\": 32.43,\n \"coords\": {\n \"latitude\": 47.615694,\n \"longitude\": -122.3359976\n }\n}", : }`
バイナリ	Funnel のエントリポイントの種類に関わらず、バイナリデータとして処理されます。(*2) `{ : "payloads": "ewogICJkZXZpY2VpZCI6ICJpb3QxMjMiLAogICJ0ZW1wIjogNTQuOTgsCiAgImh1bWlkaXR5IjogMzIuNDMsCiAgImNvb3JkcyI6IHsKICAgICJsYXRpdHVkZSI6IDQ3LjYxNTY5NCwKICAgICJsb25naXR1ZGUiOiAtMTIyLjMzNTk5NzYKICB9Cn0=", : }`
SORACOM Binary Format v1	デバイスから TCP で送信したバイナリデータを、SORACOM Binary Format v1 に準拠するものとして処理されたあとで、転送先に転送されます。 Unified Endpoint の設定によっては「(指定しない)」と同様の動作に変わります Funnel の [送信データ形式] で「SORACOM Binary Format v1」を選択して、さらに Unified Endpoint の [SORACOM Binary Format v1 でデータを受信] をオンにすると、Funnel の [送信データ形式] は「(指定しない)」を選択した場合と同様に動作します。そのため、Funnel の TCP エントリポイントにデータを送信しても、SORACOM Binary Format v1 に準拠するものとして処理されません。デバイスからエントリポイントに送信したデータの処理順序についてエントリポイントに送信したデータは、まず、SORACOM Binary Format v1、バイナリパーサー、Orbit で処理されます。データの処理順序については、SORACOM のエントリポイントに送信したデータの処理順序を参照してください。

(*1) 「(指定しない)」を選択し、かつ、Unified Endpoint の HTTP エントリポイントにデータを送信して、Funnel の転送先に送信される場合は、HTTP ヘッダーの設定にかかわらずテキストデータとして処理されます。
(*2) 仮に JSON 形式のデータと同じフォーマットで Funnel に送信した場合でも、バイナリデータとして処理されます。

バイナリデータは JSON 形式に変換されて転送されます

バイナリデータとして処理される場合は、以下の JSON 形式に変換されたうえで転送されます。payloads の値 (eyJs...) は、デバイスから送信した JSON 形式のデータを Base64 形式でエンコードしたものです。これを、payload 変換と呼びます。
```
{
    :
  "payloads": "eyJsYXQiOm51bGwsImxvbiI6bnVsbCwiYmF0IjozLCJycyI6MywidGVtcCI6MTkuOSwiaHVtaSI6NDcuNiwieCI6bnVsbCwieSI6bnVsbCwieiI6bnVsbCwidHlwZSI6MX0=",
    :
}
```
payload 変換されたデータから元のデータを取り出すには、payloads の値 (eYJs...) を Base64 形式でデコードしてください。
バイナリパーサーや Orbit で処理された場合は、処理後のデータが JSON 形式のデータとして Funnel のエントリポイントに出力されるため、payload 変換は行われません。

Soracom

Users

SORACOM Funnel から送信されるデータフォーマット