• ドキュメント
• Unified Endpoint
• 使用方法

レスポンスの形式を設定する

Unified Endpoint のレスポンスのフォーマットは以下から選択できます。

レスポンスのフォーマット Unified

レスポンスのフォーマットで「Unified」を選択した場合、もしくは「Auto (default)」を選択して有効な転送設定が 2 つ以上ある場合、Unified 形式のレスポンスが返却されます。

加えて、以下のような動作をします。

• すべての転送先からのレスポンスが返却されてから、デバイスにレスポンスが返却されます。
• Funnel は転送先へのリクエストを非同期に処理しています。そのため、転送先にリクエストが転送されるタイミングと、デバイスにレスポンスが返却されるタイミングの間には遅延が発生します。
• 転送先が設定されていない、またはすべて無効 (disabled) の場合は、フォーマットの指定によらず 400 Subscriber configuration is not found という文字列が返却されます。

フォーマットの各プロパティと、すべての転送先で正常に送信できた場合の例、いずれかの転送先でエラーが返却された場合の例は、以下のとおりです。

すべての転送先で正常に送信できた場合

{
  "statusCode": 200,
  "body": {
    "result": "ok",
    "detail": {
      "beam": { "statusCode": 200, "body": "...." },
      "funnel": { "statusCode": 204, "body": "...." },
      "funk": { "statusCode": 200, "body": "....", "encoding": "base64" },
      "harvest": { "statusCode": 204, "body": "...." }
    }
  }
}

いずれかの転送先でエラーが返却された場合

いずれかの転送先から、 HTTP ステータスコードで 400 以上の値が返却された場合にエラーと判断されます。転送先に接続できなかった場合や SORACOM プラットフォーム内でエラーが発生した場合は、エラー内容に応じたステータスコードが返却されます。

{
  "statusCode": 207,
  "body": {
    "result": "ng",
    "detail": {
      "beam": { "statusCode": 200, "body": "...." },
      "funnel": { "statusCode": 204, "body": "...." },
      "funk": { "statusCode": 200, "body": "....", "encoding": "base64" },
      "harvest": { "statusCode": 400, "body": "...." }
    }
  }
}

カスタムレスポンス機能

レスポンスのフォーマットで「カスタム」を選択した場合、成功時のレスポンスと失敗時のレスポンスを指定できます。

すべての転送先に対して正常に送信できた場合は「成功時のレスポンス」が返却されます。いずれかの転送先でエラーが返却された場合は「失敗時のレスポンス」が返却されます。