MENU
      Basic

        Basic


        Article summary

        Available in Classic and VPC

        This document describes the Basic component of the response components of a chatbot answer.

        The Basic component consists of the following three basic components.

        These components allow you to set the chatbot's response to each feature in Chatbot Builder, and return the response results in JSON format.

        Text component

        The Text component consists of the title, subtitle, description, and URL.

        Text component response body

        The following is the response body of the Text component.

        FieldTypeRequiredDescription
        typeStringRequiredComponent type
        • Only text is available among the 3 basic components for the Text component
        titleStringOptionalComponent title
        • Short bold text
        subTitleStringOptionalSubcomponent title
        • Short gray text
        dataObjectOptionalText component configuration information
        data.descriptionStringOptionalComponent detailed descriptions
        • Long text
        data.urlStringOptionalComponent hyperlink URL
        • <e.g.> ncloud.com
        data.urlAliasStringOptionalComponent hyperlink URL alias
        • Text where the hyperlink appears
          • <e.g.> NAVER Cloud
        data.actionActionOptionalComponent action information

        Text component response example

        The following is a sample response of the Text component.

        {
            "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}
                }
        }
        JSON

        Image component

        The Image component consists of an image, along with title, subtitle, description, and URL.

        Image component response body

        The following is the response body of the Image component.

        FieldTypeRequiredDescription
        typeStringRequiredComponent type
        • Only image is available among the 3 basic components for the Image component
        titleStringOptionalComponent title
        • Short bold text
        subTitleStringOptionalSubcomponent title
        • Short gray text
        dataObjectOptionalImage component configuration information
        data.imageUrlStringRequiredImage URL
        • Must be a URL of https format
        data.altStringOptionalImage description tooltip
        • Short hints when hovering over an image
        data.imagePositionStringOptionalImage position
        • top (default) | bottom | left | right
          • top: topmost
          • bottom: bottommost
          • left: leftmost
          • right: rightmost
        data.descriptionStringOptionalImage detailed description
        data.urlStringOptionalImage hyperlink URL
        • Placed at the bottom of description
        • <e.g.> ncloud.com
        data.urlAliasStringOptionalImage hyperlink URL alias
        • Text where the hyperlink appears
          • <e.g.> NAVER Cloud
        data.actionActionOptionalComponent action information

        Image component response example

        The following is a sample response of the Image component.

        {
            "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}
            }
        }
        JSON

        Button component

        The Button component consists of a button with title, subtitle, description, and URL along with an image. The Quick Buttons component is also included in the Button component.

        Button component response body

        The following is the response body of the Button component.

        FieldTypeRequiredDescription
        typeStringRequiredComponent type
        • Only button is available among the 3 basic components for the Button component
        titleStringOptionalComponent title
        • Short bold text displayed on the button
        subTitleStringOptionalSubcomponent title
        • Short gray text
        dataStringRequiredButton component configuration information
        data.typeStringRequiredButton type
        • basic | imageButton
          • basic: basic button
          • imageButton: button configured with an image
        data.iconUrlStringOptionalButton icon URL
        • Must be a URL of https format
        data.actionActionOptionalComponent action information

        Button component response example

        The following is a sample response of the Button component.

        Basic Button

        The following is a sample response of 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}
            }
        }
        JSON

        Image Button

        The following is a sample response of 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}
            }
        }
        JSON

        Quick Buttons component

        This section describes the Quick Buttons component. This is the pinned group button at the bottom of the chat window. It is included in the button component.

        Quick Buttons response body

        The following is the response body of Quick Buttons.

        FieldTypeRequiredDescription
        typeStringRequiredComponent type
        • Only button is available among the 3 basic components for the Button component
        titleStringOptionalComponent name
        dataObjectOptionalComponent configuration information
        data.typeStringConditionalComponent type
        data.actionObjectConditionalComponent action information
        data.action.typeStringConditionalComponent action type
        data.action.dataObjectConditionalComponent action details
        data.action.data.postbackStringConditionalText postbacked to the chatbot
        data.action.data.displayTextStringConditionalQuick Button name to be displayed on the chatbot
        data.action.data.postbackFullStringConditionalText postbacked to the chatbot for Quick Button execution

        Quick Buttons response example

        The following is a sample response of Quick Buttons.

        {
        "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"
                  }
                }
              }
            }
          ]
        }
        JSON

        Was this article helpful?

        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.