Soracom

TCP → HTTP/HTTPS エントリポイント (beam.soracom.io:23080) に、デバイスから TCP で送信したデータは、任意のタイミングで HTTP リクエストまたは HTTPS リクエストに変換されて、指定の URL に転送 (POST) されます。なお、TCP → HTTP/HTTPS エントリポイントに送信したデータは、たとえ JSON 形式のデータと同じフォーマットでも、バイナリデータとして処理されます。

TCP → HTTP/HTTPS エントリポイントを設定する

設定画面を表示する操作については、SORACOM Beam のエントリポイントを設定する を参照してください。TCP → HTTP/HTTPS エントリポイントで設定できる項目は以下のとおりです。

SORACOM CLI / SORACOM API の場合

グループ設定に Beam のエントリポイントを追加するコマンドについては、SORACOM Beam のエントリポイントを設定する の SORACOM CLI / SORACOM API の場合 を参照してください。

ここでは、TCP → HTTP/HTTPS エントリポイントを追加する場合のリクエストボディに指定する key と value のペアを説明します。

SORACOM CLI のコマンド例:

$ soracom groups put-config --group-id {group_id} --namespace SoracomBeam \
--body '[
  {
    "key": "tcp://beam.soracom.io:23080",
    "value": {
      "name": "tcp2https",
      "enabled": true,
      "destination": "https://beamtest.soracom.io",
      "version": "202411"
      "addSubscriberHeader": true,
      "addSimIdHeader": false,
      "addMsisdnHeader": false,
      "addEquipmentHeader": false,
      "addSignature": true,
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "append",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      },
      "skipStatusCode": true,
      "eodBytes": "",
      "psk": {
        "$credentialsId": "CredentialsID"
      },
      "useSoracomBinaryFormat": false
    }
  }
]'

TCP → HTTP/HTTPS エントリポイントの Object

以下の key と value を指定します。なお、この key と value のペアは、通常の JSON Object として指定します。

TCP → HTTP/HTTPS エントリポイントにリクエストする

TCP → HTTP/HTTPS エントリポイントに、デバイスからデータを送信します。

以下は、デバイスで nc コマンドを利用して、TCP → HTTP/HTTPS エントリポイント (beam.soracom.io:23080) にデータを送信する場合の例です。

$ nc -v beam.soracom.io 23080
Connection to beam.soracom.io (100.127.127.100) 23080 port [tcp/*] succeeded!
Test data # 送信するデータを入力して、Enter キーを押します。

${HTTP ステータスコード} ${転送先サーバーから返された HTTP レスポンスのボディ}${[データ終端バイト列] に指定したバイト列}

プラットフォームバージョン 201509 と 202411 の違い

TCP → HTTP/HTTPS エントリポイントのプラットフォームバージョンによって、以下の点が異なります。

• デバイスへのレスポンスのデータ終端バイト列のデフォルト値
• デバイスへのエラーレスポンス

レスポンスのデータ終端バイト列のデフォルト値

TCP → HTTP/HTTPS エントリポイントの Object が eodBytes プロパティを含まない場合、[プラットフォームバージョン] の設定によって、データ終端バイト列が異なります。

ユーザーコンソールで設定を行う場合、TCP → HTTP/HTTPS エントリポイントの Object は必ず eodBytes プロパティを含んでいます。[データ終端バイト列] の欄を空白にして TCP → HTTP/HTTPS エントリポイントの設定を作成すると、ユーザーコンソールは自動的に "eodBytes": "" (空の文字列) として eodBytes プロパティを追加します。

API から手動で TCP → HTTP/HTTPS エントリポイントの設定を登録する場合、Object が eodBytes プロパティを含むかどうかを確認してください。

デバイスへのエラーレスポンス

転送先サーバーが HTTP ステータスコード 400 以上のレスポンスを返却した場合、TCP → HTTP/HTTPS エントリポイントではエラーレスポンスとみなされます。このときデバイスには、プラットフォームバージョンに応じて定められたレスポンス形式で、TCP パケットのペイロードとして送信されます。

なお、エラーレスポンスに含まれるデータの違いやカスタマイズできるかどうかについて詳しくは、エラーレスポンスに含まれるデータの違い を参照してください。

• プラットフォームバージョン 201509 の場合:

  ${HTTP ステータスコード} ${転送先の URL} returns a status code (${HTTP ステータスコード}). Please check your destination.\r\n
  

  レスポンスの具体例

  レスポンスの具体例は以下のとおりです。

  • 転送先サーバーから、HTTP ステータスコードが 400 で、ボディ (Message from server) がある HTTP レスポンスが返された場合の表示例:

    400 https://example.com:443/to/ returns a status code (400). Please check your destination.\r\n
    

• プラットフォームバージョン 202411 の場合:

  ${HTTP ステータスコード} ${転送先サーバーから返された HTTP レスポンスのボディ}${[データ終端バイト列] に指定したバイト列}
  

  レスポンスの具体例

  レスポンスの具体例は以下のとおりです。

  • 転送先サーバーから、HTTP ステータスコードが 400 で、ボディ (Message from server) がある HTTP レスポンスが返され、[データ終端バイト列] が 0a だった場合の表示例:

    400 Message from server\n
    

  • 転送先サーバーから、HTTP ステータスコードが 400 で、ボディ (Message from server) がある HTTP レスポンスが返され、[データ終端バイト列] が空欄だった場合の表示例:

    400 Message from server