Flex

Prev Next

Classic/VPC環境で利用できます。

チャットボット返答のレスポンスコンポーネントのうち、Flexについて説明します。

Flexコンポーネントは、次の4つの基本コンポーネントで構成されます。

上記のコンポーネントはそれぞれの特徴に合わせてチャットボットのレスポンスをチャットボットビルダで設定することができ、チャットボットビルダで設定したレスポンス結果を JSON形式で返します。

参考

Flexコンポーネントはすべての JSONオブジェクト形式をサポートし、必要に応じて独自の JSONスペックを定義します。
<例> FlexMessageContainerObject

Flexコンポーネント

Flexコンポーネントについて説明します。

Flexコンポーネントのレスポンスボディ

Flexコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Flexコンポーネントの場合、flexのみ使用可能
title String Required コンポーネントのタイトル
  • 太字の短文テキスト(Short bold text)
  • チャットリストやプッシュ通知の置換テキストとして使用
subTitle String Optional 下位コンポーネントタイトル
  • 使用しない
data String Required Flexコンポーネントの構成情報
  • 任意の JSONオブジェクトファイルを使用可能
  • <例> LINE FlexメッセージはFlex Message Simulatorで JSONコピーができる

Flexコンポーネントのレスポンス例

Flexコンポーネントのレスポンスのサンプルコードは次の通りです。

{
"type": "flex",
"title": "not used",
"subTitle": "required, alternative text",
"data" : {} // any json object 
}

Special Messengerコンポーネント

Special Messengerコンポーネントは LineFlex、LineSticker、LineWorksStickerなど CLOVA Chatbotで連携可能な外部メッセンジャーで利用されるコンポーネントです。

LineFlexコンポーネント

LineFlexコンポーネントについて説明します。

LineFlexコンポーネントのレスポンスボディ

LineFlexコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • Flexコンポーネントの場合、flexのみ使用可能
title String Required コンポーネントのタイトル
  • 太字の短文テキスト(Short bold text)
  • チャットリストやプッシュ通知の置換テキストとして使用
subTitle String Optional 下位コンポーネントタイトル
  • 使用しない
data String Required Flexコンポーネントの構成情報
  • 任意の JSONオブジェクトファイルを使用可能
  • <例> LINE FlexメッセージはFlex Message Simulatorで JSONコピーができる
参考

LINEメッセンジャーがサポートする LineFlex機能は共通の Flexコンポーネント形式に変更されましたが、構成要素は同じです。

LineFlexコンポーネントのレスポンス例

LineFlexコンポーネントのレスポンスのサンプルコードは次の通りです。

{
"type": "flex",
"title": "not used",
"subTitle": "required, alternative text",
"data" : {} // any json object 
}

LineStickerコンポーネント

LineStickerコンポーネントは、LINEメッセンジャーがサポートする LineStickerステッカーリストの形式に応じてステッカーメッセージを設定できます。

LineStickerコンポーネントのレスポンスボディ

LineStickerコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • LineStickerコンポーネントの場合、line_stickerのみ使用可能
data Object Required LineStickerコンポーネント情報
data.packageId String Required LINE Stickerパッケージ ID
data.stickerId String Required LINE Stickerステッカー ID

LineStickerコンポーネントのレスポンス例

LineStickerコンポーネントのレスポンスのサンプルコードは次の通りです。

{
    "type": "line_sticker",
    "data" : 
    {  
        "packageId": "packageId of LINE",
        "stickerId": "stickerId of LINE"
    }
}

LineWorksStickerコンポーネント

LineWorksStickerコンポーネントは、LINE WORKSがサポートする LineWorksStickerステッカーリストの形式に応じてステッカーメッセージを設定できます。

LineWorksStickerコンポーネントのレスポンスボディ

LineWorksStickerコンポーネントのレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
type String Required コンポーネントのタイプ
  • LineWorksStickerコンポーネントの場合、lineworks_stickerのみ使用可能
data Object Required LineWorksStickerコンポーネント情報
data.packageId String Required LINEWORKS Stickerパッケージ ID
data.stickerId String Required LINEWORKS Stickerステッカー ID

LineWorksStickerコンポーネントのレスポンス例

LineWorksStickerコンポーネントのレスポンスのサンプルコードは次の通りです。

{
    "type": "lineworks_sticker",
    "data" : 
    {
        "packageId": "packageId of LINEWORKS",
        "stickerId": "stickerId of LINEWORKS"
    }
}