SORACOM Developers

Unified Endpoint : 機能の説明

Unified Endpointの対象となるサービス

Unified Endpoint は、SORACOM Air for セルラー、SORACOM Air for LoRaWAN、SORACOM Air for Sigfoxを使用しているデバイス、および SORACOM Inventory のクラウド連携から利用できます。また、グローバル向け SIM(plan01s, plan01s - Low Data Volume)では、「SMS を使用したクラウド連携」「USSD機能」にも対応しています。

SORACOM Air for セルラー

SORACOM Air for セルラーをご利用の場合、Unified Endpoint は UDP、TCP、HTTP に対応しています。 それぞれ、エントリポイント、ポートは以下のとおりです。

プロトコル エントリポイント ポート
UDP uni.soracom.io
unified.soracom.io
23080
TCP uni.soracom.io
unified.soracom.io
23080
HTTP uni.soracom.io
unified.soracom.io
80,8888

uni.soracom.iounified.soracom.io のいずれかをご利用ください。動作に違いはありません。

SORACOM Air for LoRaWAN、SORACOM Air for Sigfox

SORACOM Air for LoRaWAN、SORACOM Air for Sigfoxをご利用の場合、各デバイスでエンドポイントを指定する必要はありません。 各サービスの利用をご確認ください。

SMS を使用したクラウド連携

Air SIM(plan01s, plan01s - Low Data Volume)を使用したデバイスから、以下の宛先に SMS 送信することで Unified Endpoint を使用できます。

なお、各サービスの宛先もこれまでと変わりなくご利用いただけます。

USSD 機能

USSD 機能を利用したデータ送信時は、*{Service Code}*{任意のデータ}# という形式の MMI 文字列を使用します。 Unified Endpoint を利用する場合は、 Service Code 部に以下の値を指定します。

なお、各サービスの宛先もこれまでと変わりなくご利用いただけます。

USSD 機能は、Air SIM(plan01s, plan01s - Low Data Volume)でご利用できます。USSD の詳細はUSSD を用いて Beam / Funnel / Harvest にデータを送信するをご確認ください。

各サービスの利用

Unified Endpoint(unified.soracom.io) に送信されたデータは、グループ設定で Beam、Funnel、Harvest の設定が有効となっている送信先にデータを送信します。

例えば、以下のように動作します。

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

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

フォーマット エントリポイント
Auto(default) 有効な転送設定が1つの場合は当該のサービスのフォーマットでレスポンスを返します。2つ以上ある場合は 「Unified」 レスポンスフォーマットでレスポンスを返却します。
Unified Unified Endpointのレスポンスのフォーマットでレスポンスを返却します(後述)
SORACOMBeam Beam のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません
SORACOMFunnel Funnel のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません
SORACOMHarvest Harvest のレスポンスのみを返却します。他の転送設定がある場合、データは転送しますがその結果は返しません
カスタム 指定したレスポンスを常に返却します。成功時、エラー時のレスポンスをそれぞれ設定できます。

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

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

以下のようなフォーマットとなります。

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

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

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

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

レスポンスのフォーマット カスタム

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

unified_endpoint_overview

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

設定 説明
HTTP ステータスコード 成功時および失敗時のステータスコードを指定します
Content-Type ヘッダーの値 レスポンスの Content-Type ヘッダーの値を指定してください。たとえば application/json を指定します。
Body レスポンス Body の値を指定します。
ステータスコードを省略 当設定は TCP/UDP 送信時のレスポンスが対象となります。送信後のレスポンスにステータスコードを含みません。(Bodyのみが送信されます。)
pagetop