USSD → HTTP/HTTPS エントリポイント (901011) に、デバイスから USSD で受信したデータを以下の JSON 形式に変換して、1 つの HTTP リクエストまたは HTTPS リクエストとして指定の URL に転送 (POST) します。
{
"imsi": "29505xxxxxxxxxx",
"ussdDataCodingScheme": 15,
"ussdString": "*901011*123#",
"value": "123"
}
| 項目 | 説明 |
|---|---|
imsi | IoT SIM の IMSI です。 |
ussdDataCodingScheme | 常に 15 (GSM 7 ビット標準アルファベット) です。 |
ussdString | AT コマンドで指定した文字列です。 |
value | ussdString から取り出したテキストメッセージです。 |
USSD → HTTP/HTTPS エントリポイントを設定する
設定画面を表示する操作については、SORACOM Beam のエントリポイントを設定する を参照してください。USSD → HTTP/HTTPS エントリポイントで設定できる項目は以下のとおりです。
| 項目 | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
任意の名前を入力します。 同じ名前の設定を追加できますは、エントリポイントの一意のキーとして扱われません。ほかのエントリポイントと同じ名前を設定できます。 | |||||||||||
| この設定の有効 / 無効を切り替えます。 | |||||||||||
このエントリポイントで受け付けたリクエストの転送先を設定します。
| |||||||||||
| 転送先へのリクエストに追加するヘッダーを設定します。詳しくは、HTTP エントリポイントの [ヘッダ操作] を参照してください。 |
SORACOM CLI / SORACOM API の場合
グループ設定に Beam のエントリポイントを追加するコマンドについては、SORACOM Beam のエントリポイントを設定する の SORACOM CLI / SORACOM API の場合 を参照してください。
ここでは、USSD → HTTP/HTTPS エントリポイントを追加する場合のリクエストボディに指定する key と value のペアを説明します。
key | value の型 | value |
|---|---|---|
ussd:901011 | Object | USSD → HTTP/HTTPS エントリポイントの Object を参照してください。 |
SORACOM CLI のコマンド例:
$ soracom groups put-config --group-id {group_id} --namespace SoracomBeam \
--body '[
{
"key": "ussd:901011",
"value": {
"name": "USSDToHTTP",
"enabled": true,
"destination": "https://beamtest.soracom.io/",
"addSubscriberHeader": true,
"addSimIdHeader": false,
"addMsisdnHeader": false,
"addSignature": true,
"psk": {
"$credentialsId": "CredentialsID"
},
"customHeaders": {
"X-GROUP-NAME": {
"action": "append",
"headerKey": "X-GROUP-NAME",
"headerValue": "TEST"
}
}
}
}
]'
SORACOM CLI や API で設定を更新するときは
Beam のエントリポイントの設定を部分的に更新するときは、更新しない設定も含めて、すべての設定を漏れなく指定してください。更新する設定だけを指定すると、省略した設定は初期値に戻ります。
想定していない値を指定した場合の動作は、定義されていません。SORACOM CLI / SORACOM API で設定を変更したあとで、SORACOM ユーザーコンソールで意図通りに設定されていることを確認してください。
USSD → HTTP/HTTPS エントリポイントの Object
以下の key と value を指定します。なお、この key と value のペアは、通常の JSON Object として指定します。
| key | value の型 | value | ||||||
|---|---|---|---|---|---|---|---|---|
name | String | 任意の名前を入力します。 同じ名前の設定を追加できます
| ||||||
enabled | Boolean | このエントリポイントの有効 / 無効を設定します。
| ||||||
destination | String | エントリポイントで受け付けたリクエストの転送先 (URL) を入力します。例: https://example.com:443/to/ | ||||||
addSubscriberHeader | Boolean | 転送先へのリクエストに
| ||||||
addSimIdHeader | Boolean | 転送先へのリクエストに
| ||||||
addMsisdnHeader | Boolean | 転送先へのリクエストに
| ||||||
addSignature | Boolean | 転送先へのリクエストに
| ||||||
psk.$credentialsId | String | addSignature が true のときに、署名に利用する事前共有鍵の認証情報 IDを指定します。認証情報 ID は、認証情報ストア に事前共有鍵を登録したときに指定しています。詳しくは、署名ヘッダと事前共有鍵を使って送信元を検証する を参照してください。 | ||||||
customHeaders | Object | 転送先へのリクエストヘッダーを追加、置換、削除できます。
リクエストヘッダーは大文字小文字が区別されませんでは、大文字小文字を区別して登録できますが、一般に、リクエストヘッダーは大文字小文字が区別されません。大文字小文字を同一視した結果、同じ値になるヘッダーを複数登録した場合の動作は保証されません。 |
USSD → HTTP/HTTPS エントリポイントにリクエストする
USSD → HTTP/HTTPS エントリポイント (901011) に、デバイスから *901011*{テキストデータ}# の形式でデータを送信します。詳しくは、デバイスから USSD でデータを送信する を参照してください。
ヘッダー操作について
デバイスが送信したデータが転送先の URL に転送される際、Beam によって以下のヘッダー操作が行われます。
- の設定に従って、ヘッダーが追加、置換、削除されます。詳しくは、HTTP エントリポイントの [ヘッダ操作] を参照してください。
デバイスへのレスポンス
転送先の HTTP/HTTPS サーバーが、以下の条件を満たす HTTP レスポンスを返すと、デバイスへでレスポンスを受け取ることができます。
Content-Type: text/plainを設定する- GSM 7 ビット標準アルファベットの範囲の文字のみを用いる
- 182 文字以内