Basic
    • PDF

    Basic

    • PDF

    記事の要約

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

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

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

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

    Textコンポーネント

    Textコンポーネントは、タイトル(Title)、サブタイトル(Sub Title)、説明(Description)、URLで構成されます。

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

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

    フィールドタイプ必須の有無説明
    typeStringRequiredコンポーネントのタイプ
    • Textコンポーネントの場合、3つの基本コンポーネントのうちtextのみ使用可能
    titleStringOptionalコンポーネントのタイトル
    • 太字の短文テキスト(Short bold text)
    subTitleStringOptional下位コンポーネントのタイトル
    • グレーの短文テキスト(Short gray text)
    dataObjectOptionalテキスト(Text)コンポーネントの構成情報
    data.descriptionStringOptionalコンポーネントの詳細説明
    • 長文のテキスト
    data.urlStringOptionalコンポーネントのハイパーリンク URL
    • <例> ncloud.com
    data.urlAliasStringOptionalコンポーネントハイパーリンク URLのエイリアス
    • ハイパーリンクが表示されるテキスト
      • <例> NAVERクラウド
    data.actionActionOptionalコンポーネントアクション(Action)情報

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

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

    { 
        "type": "text", 
        "title": "optional, short bold text", 
        "subTitle": "optional, short gray text",
        "data" : 
            {
                "description" : "optional, a long text content",
                "url" : "optional, a hyperlink at the bottom of description",
                "urlAlias" :"optional, hyperlink show this alias",
                "action": {Action Data} 
            }
    }
    

    Imageコンポーネント

    Imageコンポーネントは、画像とともにタイトル(Title)、サブタイトル(Sub Title)、説明(Description)、URLで構成されます。

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

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

    フィールドタイプ必須の有無説明
    typeStringRequiredコンポーネントのタイプ
    • Imageコンポーネントの場合、3つの基本コンポーネントのうちimageのみ使用可能
    titleStringOptionalコンポーネントのタイトル
    • 太字の短文テキスト(Short bold text)
    subTitleStringOptional下位コンポーネントのタイトル
    • グレーの短文テキスト(Short gray text)
    dataObjectOptional画像(Image)コンポーネントの構成情報
    data.imageUrlStringRequired画像の URL
    • https形式の URLが必要
    data.altStringOptional画像説明のツールチップ
    • 画像にマウスオーバーすると表示される短いヒント
    data.imagePositionStringOptional画像の位置
    • top(デフォルト) | bottom | left | right
      • top: 一番上
      • bottom: 一番下
      • left: 一番左
      • right: 一番右
    data.descriptionStringOptional画像の詳細説明
    data.urlStringOptional画像のハイパーリンク URL
    • descriptionの下に位置
    • <例> ncloud.com
    data.urlAliasStringOptional画像ハイパーリンク URLのエイリアス
    • ハイパーリンクが表示されるテキスト
      • <例> NAVERクラウド
    data.actionActionOptionalコンポーネントアクション(Action)情報

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

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

    {
        "type": "image",
        "title": "optional, short bold text",
        "subTitle": "optional, short gray text",
        "data" : 
        {
            "imageUrl" : "https://ssl.pstatic.net/CloudFunctions.png",
            "alt" : "optional, short hint show when hover on image",
            "imagePosition" : "top",
            "description" : "optional, details info of image",
            "url" : "optional, a hyperlink at the bottom of description",
            "urlAlias" : "optional, hyperlink show this alias",
            "action": {Action Data}
        }
    }
    

    Buttonコンポーネント

    Buttonコンポーネントは、画像とともにタイトル(Title)、サブタイトル(Sub Title)、説明(Description)、URLでボタン(Button)を構成します。Quick Buttonコンポーネントも Buttonコンポーネントに含まれます。

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

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

    フィールドタイプ必須の有無説明
    typeStringRequiredコンポーネントのタイプ
    • Buttonコンポーネントの場合、3つの基本コンポーネントのうちbuttonのみ使用可能
    titleStringOptionalコンポーネントのタイトル
    • ボタンに表示される太字の短文テキスト(Short bold text)
    subTitleStringOptional下位コンポーネントのタイトル
    • グレーの短文テキスト(Short gray text)
    dataStringRequiredボタン(Button)コンポーネントの構成情報
    data.typeStringRequiredボタンの種類
    • basic | imageButton
      • basic: 基本ボタン
      • imageButton: 画像で構成されたボタン
    data.iconUrlStringOptionalボタンアイコン URL
    • https形式の URLが必要
    data.actionActionOptionalコンポーネントアクション(Action)情報

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

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

    Basic Button

    Basic Buttonのレスポンスのサンプルコードは次の通りです。

    {
        "type": "button",
        "title": "optional, text show on button",
        "subTitle": "optional, short gray text",
        "data" : 
        {
            "type": "basic",
            "iconUrl" : "https://ssl.pstatic.net/CloudFunctions.png",
            "action": {Action Data}
        }
    }
    

    Image Button

    Image Buttonのレスポンスのサンプルコードは次の通りです。

    {
        "type": "button",
        "title": "optional, text show on button",
        "subTitle": "optional, short gray text",
        "data" : 
        {
            "type": "imageButton",
            "iconUrl" : "https://ssl.pstatic.net/CloudFunctions.png",
            "action": {Action Data}
        }
    }
    

    Quick Buttonsコンポーネント

    Quick Buttonsコンポーネントを説明します。チャット画面下部にあるグループ固定ボタンです。buttonコンポーネントに含まれます。

    Quick Buttonsのレスポンスボディ

    Quick Buttonsnのレスポンスボディは次の通りです。

    フィールドタイプ必須の有無説明
    typeStringRequiredコンポーネントのタイプ
    • Buttonコンポーネントの場合、3つの基本コンポーネントのうちbuttonのみ使用可能
    titleStringOptionalコンポーネントの名前
    dataObjectOptionalコンポーネントの構成情報
    data.typeStringConditionalコンポーネントのタイプ
    data.actionObjectConditionalコンポーネントのアクション(Action)情報
    data.action.typeStringConditionalコンポーネントアクションのタイプ
    data.action.dataObjectConditionalコンポーネントアクション(Action)の詳細情報
    data.action.data.postbackStringConditionalチャットボットにポストバックしたテキスト
    data.action.data.displayTextStringConditionalチャットボットに表示されるクイックボタン(Quick Button)の名前
    data.action.data.postbackFullStringConditionalクイックボタン実行のためにチャットボットにポストバックしたテキスト

    Quick Buttonsのレスポンス例

    Quick Buttonsnのレスポンスのサンプルコードは次の通りです。

    {
    "quickButtons": [
        {
          "type": "button",
          "title": "Button Name",
          "data": {
            "type": "basic",
            "action": {
              "type": "postback",
              "data": {
                "postback": "UnexpiredForm\u241e47954\u241e0",
                "displayText": "Button Name",
                "postbackFull": "_T_UnexpiredForm\u241e47954\u241e0" 
              }
            }
          }
        }
      ]
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.