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

TCP で受信したデータを、JSON 形式に変換して 1 つのリクエストとして HTTP または HTTPS に POST します。受け取ったデータはバイナリである可能性もあるため、Base64 エンコードされて下記のような形式で POST されます。

{
  "payload": "Base64 エンコードされたデータ"
}

設定項目

SORACOM ユーザーコンソールの場合

設定名: 本設定の名前
転送先
- プロトコル: 転送先への送信プロトコル。HTTP もしくは HTTPS から選択。
- ホスト名: 転送先の FQDN。
- ポート番号: 転送先のポート番号。
- パス: 転送先へのリクエストパス。
ヘッダ操作
- IMSI ヘッダ: 転送先へのリクエストに x-soracom-imsi: ${IMSI} を追加します。
- SIM ID ヘッダ: 転送先へのリクエストに x-soracom-sim-id: ${SIM_ID} を追加します。
- MSISDN ヘッダ: 転送先へのリクエストに x-soracom-msisdn: ${MSISDN} を追加します。
- IMEI ヘッダ: 転送先へのリクエストに x-soracom-imei: ${IMEI} を追加します。
- 署名ヘッダ付与: 転送先へのリクエストに x-soracom-signature: ${signature} を追加します。
- 事前共有鍵: 署名に利用する共通鍵を設定します。詳細は、署名ヘッダと事前共有鍵を使って送信元を検証するを参照してください。
- カスタムヘッダ: 転送先へのリクエストに任意の HTTP ヘッダーを付与できます。
レスポンス
- ステータスコードを省略: レスポンスに HTTP のステータスコードを含まないようにします。詳しくは、レスポンスのステータスコードを省略するを参照してください。

SORACOM CLI / SORACOM API の場合

soracom groups put-config (Group:putConfigurationParameters API) を使用します。

{namespace} は、SoracomBeam です。

ボディで指定するプロパティについては、以下の key と value のペアを配列で指定します。

"tcp://beam.soracom.io:23080": { // 固定
  "name": "string", // 任意
  "destination": "tcps://secure.example.com:1234", // 通信先のホスト名＆ポートを指定
  "enabled": true | false, // TCP → HTTP/HTTPS エントリポイントの有効・無効
  "addSubscriberHeader": true | false, // 通信開始時に Subscriber の情報を送るか否か
  "addSignature": true | false, // 検証用のシグネチャを付与するか否か
  "psk": "string", // 検証用シグネチャを計算する際の事前共有パスフレーズ
  "customHeaders": { // 独自HTTPヘッダ
    "X-HEADER-NAME": { // 独自ヘッダの名前
      "action": "append" // 追記のみ可能
      "headerKey": "X-HEADER-NAME",
      "headerValue": "VALUE" // ヘッダに設定する内容
    }
  }
}

設定例

[
  {
    "key": "tcp://beam.soracom.io:23080",
    "value": {
      "name": "telnet2https",
      "destination": "https://beamtest.soracom.io/",
      "enabled": true,
      "addSubscriberHeader": true,
      "addSignature": true,
      "psk": "topsecret",
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "append",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      }
    }
  }
]

エントリポイント

beam.soracom.io:23080

リクエスト

Beam は送信されたメッセージを Base64 エンコードしたうえで以下のような JSON にし、HTTP POST リクエストのボディに設定します。

{
  "payload": "Base64 エンコードされたデータ"
}

TCP 上で送信されたデータをクラウドサービスに送信します。なお、HTTP ヘッダの user_agent には"SORACOM Beam"という文字列が設定されます。

レスポンス

TCP には HTTP のようなリクエスト&レスポンスの概念はありませんので、以下のコードやメッセージをペイロードとして含んだ TCP パケットが、TCP → HTTP/HTTPS エントリポイントからデバイスにレスポンスされます。フォーマットは以下のとおりです。レスポンス送信のタイミングは、転送先サーバーからのレスポンスに基づきます。

${HTTP ステータスコード} ${転送先サーバーから返された HTTP レスポンスのボディ}

実際の利用例

TCP → HTTP/HTTPS エントリポイントとの TCP セッションを確立して、データを送信します。

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

転送先サーバーから、HTTP ステータスコードが 200 で、ボディがない HTTP レスポンスが返された場合の表示例:

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

400 Message from server