Soracom

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

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

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

SORACOM CLI / SORACOM API の場合

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

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

SORACOM CLI のコマンド例:

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

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

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

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

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

以下は、デバイスで nc コマンドを利用して、UDP → HTTP/HTTPS エントリポイント (beam.soracom.io:23080) にデータを送信する場合の例です。例の最後の 200 は、転送先の HTTP/HTTPS サーバーが返した HTTP ステータスコードです。

$ echo "test message" | nc -v -u beam.soracom.io 23080

Connection to beam.soracom.io port 23080 [udp/*] succeeded!

200

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

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

UDP → HTTP/HTTPS エントリポイントのプラットフォームバージョンによって、デバイスへのエラーレスポンス が異なります。

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

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

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

  ${HTTP ステータスコード} ${転送先の URL} returns a status code (${HTTP ステータスコード}). Please check your destination.
  ${HTTP ステータスコード} ${転送先サーバーから返された HTTP レスポンスのボディ}
  

  1 行目と 2 行目の間には \r\n が含まれます。

  レスポンスの具体例

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

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

    400 https://example.com:443/to/ returns a status code (400). Please check your destination.
    400 Message from server
    

    1 行目と 2 行目の間には \r\n が含まれます。

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

    400 https://example.com:443/to/ returns a status code (400). Please check your destination.
    Message from server
    

    1 行目と 2 行目の間には \r\n が含まれます。

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

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

  レスポンスの具体例

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

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

    400 Message from server
    

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

    Message from server