HTTP リクエストコンポーネントの設定 - Chat App Message Service

このトピックでは、指定された URL に HTTP リクエストを送信する HTTP リクエスト コンポーネントの設定方法について説明します。

コンポーネント情報

アイコン	名前
	HTTP リクエスト

前提条件

このコンポーネントを設定するには、既存のフローを使用するか、新しいフローを作成して、フローのキャンバスにアクセスしてください。

既存のフローのキャンバスに移動する
フローエディター > フロー管理 > フロー名
新しいフローを作成して、そのキャンバスを開きます。詳細については、「フローの作成」をご参照ください。

操作手順

キャンバス上の HTTP リクエスト コンポーネントアイコンをクリックすると、右側に設定パネルが表示されます。
右側の設定パネルには、incomingMessage、wabaId、wabaPhoneNumber などの変数を含む 利用可能な変数 セクションと、基本設定 セクションがあります。基本設定セクションでは、リクエストメソッド (デフォルトは GET)、タイムアウト (秒単位)、URL (必須)、および 失敗ブランチ スイッチを設定できます。また、[Add Request Header] や [Add Path Parameter] をクリックしてオプションを追加することもできます。完了したら、右上隅の [Save] をクリックします。
必要に応じてコンポーネントのパラメーターを設定します。詳細については、「パラメーター」をご参照ください。
設定が完了したら、保存をクリックします。表示されるダイアログボックスで、保存をクリックします。

パラメーター

パラメーター	説明	例
[リクエストメソッド]	リクエストの HTTP メソッドです。次のメソッドがサポートされています： POST GET	基本設定には、タイムアウト (秒単位)、URL (必須)、失敗ブランチ (デフォルトで無効) などのパラメーターも含まれます。
[タイムアウト]	レスポンスを待機する時間 (秒単位) です。この時間を経過するとリクエストはタイムアウトします。
[アドレス]	リクエストを受信するエンドポイント URL です。
[コンテンツタイプ]	[コンテンツタイプ] が POST の場合、コンテンツタイプを指定する必要があります。次のタイプがサポートされています： application/json application/x-www-form-urlencoded
[失敗したブランチ]	このスイッチをオンにすると、失敗したリクエストを処理するための個別のブランチがフローで有効になります。
[リクエストヘッダーの設定]	リクエストヘッダーの次のパラメーターを設定します：キー値	[Key] に `accesstoken` と入力し、[Value] に対応するトークン値を入力します。既存の変数を使用する場合は、[変数を挿入] をクリックします。リクエストヘッダーを追加するには、[Add Request Header] をクリックします。
[リクエストボディの設定]	リクエストメソッドが POST の場合、リクエストボディを次のいずれかの形式で設定できます：キーと値：キー値 raw：リクエストボディのコンテンツを手動で入力します。詳細については、「リクエストボディ設定」をご参照ください。	リクエストボディのパラメーターを設定する際、キーと値モードを選択して [Key] と [Value] を設定するか、raw モードを選択して手動でコンテンツを入力します。[変数を挿入] をクリックして変数の値を追加したり、[Add Body] をクリックしてパラメーターを追加したりできます。
[リクエスト URI の構成]	リクエストメソッドが GET の場合、リクエストパスのパラメーターを設定できます：キー値	GET リクエストの URL パラメーターを設定する際、[Key] を `phone` に、[Value] を `{{$.PhoneNumber}}` に設定します。[+ 変数を挿入] をクリックして変数の値を追加したり、[+ Add Parameter] をクリックしてパラメーターを追加したりできます。
[応答変数の設定]	変数名は、JSON レスポンスオブジェクトのキーと一致している必要があります。	応答変数設定セクションで、変数名を入力します。[+ Add Variable] をクリックして変数を追加するか、削除アイコンをクリックして既存の変数を削除します。

リクエストボディ設定

リクエストボディは、[キー値] モードと [元の値] モードの 2 つのモードで設定できます。

[キー値]：このモードは、単純なリクエストボディ構造に推奨されます。例：
最初のキーと値のペアのキーを MyName に、値を haiwei.dhw に設定します。2 番目のペアでは、キーを customerName に、値を変数 {{customerName}} に設定します。
コンテンツタイプ が application/json の場合、データ形式は {"myName": "haiwei.dhw", "customerName": "{{customerName}}"} です。コンテンツタイプ が application/x-www-form-urlencoded の場合、データ形式は "myName=haiwei.dhw&customerName={{customerName}}" です。
[元の値]：このモードは、複雑なリクエスト構造に推奨されます。リクエストボディ全体を自由に編集できます。入力するコンテンツは、選択した [元の値] である application/json または application/x-www-form-urlencoded と一致する必要があります。
application/json
コンテンツタイプ が application/json の場合、raw リクエストボディは次のように構成できます：
```
{
  "customerNames": [
    {
      "name": "{{customerName}}",
      "type": "vip",
      "intentional": true,
      "intentionLevel": 5
    }
  ],
  "myName": "haiwei.dhw",
  "someConplicatedStructure": {
    "a": {
      "b": "c"
    }
  }
}
```
application/x-www-form-urlencoded
コンテンツタイプ が application/x-www-form-urlencoded の場合、raw リクエストボディは次のように構成できます：
```
customerNames[0][name]={{customerName}}&customerNames[0]
[type]=vip&customerNames[0]
[intentional]=true&customerNames[0]
[intentionLevel]=5&myName=haiwei.dhw&someConplicatedStructure[a][b]=c
```

コンポーネント情報

前提条件

操作手順

パラメーター

リクエストボディ設定

application/json

application/x-www-form-urlencoded