レスポンスの形式を設定する
Unified Endpoint のレスポンスのフォーマットは以下から選択できます。
| フォーマット | エントリポイント |
|---|---|
| Auto (default) | 有効な転送設定が 1 つの場合は当該のサービスのフォーマットでレスポンスを返します。2 つ以上ある場合は 「Unified」 レスポンスフォーマットでレスポンスを返却します。 |
| Unified | Unified Endpoint のレスポンスのフォーマットでレスポンスを返却します (後述) |
| SORACOMBeam | Beam のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません |
| SORACOMFunnel | Funnel のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません |
| SORACOMFunk | Funk のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません |
| SORACOMHarvest | Harvest のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません |
| カスタム | 指定したレスポンスを常に返却します。成功時、エラー時のレスポンスをそれぞれ設定できます。 |
レスポンスのフォーマット Unified
レスポンスのフォーマットで「Unified」を選択した場合、もしくは「Auto (default)」を選択して有効な転送設定が 2 つ以上ある場合、Unified Endpoint のレスポンスを返却します。すべてのサービスのレスポンスを待った後にデバイス側へ返却します。
以下のようなフォーマットとなります。
すべての転送先で正常に送信できた場合
{
"statusCode": 200,
"body": {
"result": "ok",
"detail": {
"beam": { "statusCode": 200, "body": "...." },
"funnel": { "statusCode": 204, "body": "...." },
"funk": { "statusCode": 200, "body": "...." },
"harvest": { "statusCode": 204, "body": "...." }
}
}
}
いずれかの転送先でエラーが返却された場合
{
"statusCode": 207,
"body": {
"result": "ng",
"detail": {
"beam": { "statusCode": 200, "body": "...." },
"funnel": { "statusCode": 204, "body": "...." },
"funk": { "statusCode": 200, "body": "...." },
"harvest": { "statusCode": 400, "body": "...." }
}
}
}
レスポンスのフォーマット カスタム
レスポンスのフォーマットで「カスタム」を選択した場合、成功時のレスポンスと失敗時のレスポンスを指定できます。
すべての転送先に対して正常に送信できた場合は「成功時のレスポンス」が返却されます。いずれかの転送先でエラーが返却された場合は「失敗時のレスポンス」が返却されます。
| 設定 | 説明 |
|---|---|
| HTTP ステータスコード | 成功時および失敗時のステータスコードを指定します |
Content-Type ヘッダーの値 | レスポンスの Content-Type ヘッダーの値を指定してください。たとえば application/json を指定します。 |
| Body | レスポンス Body の値を指定します。 |
| ステータスコードを省略 | 当設定は TCP/UDP 送信時のレスポンスが対象となります。送信後のレスポンスにステータスコードを含みません。(Body のみが送信されます。) |