CLOVA Chatbot Custom API Example
    • PDF

    CLOVA Chatbot Custom API Example

    • PDF

    기사 요약

    개요

    • CLOVA Chatbot의 다양한 응답 형식에 대해서 예제 형식을 통해 알기 쉽게 설명합니다.

    CLOVA Chatbot 응답 예시

    기본 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664169457884,
      "bubbles": [
        {
          "type": "text",
          "data": {
            "description": "Chatbot Answer",
            "url": "https://ncloud.com", // optional : URL
            "urlAlias": "https://ncloud.com" // optional : URL
          },
          "information": [
            {
              "key": "chatType",
              "value": "TEXT"
            },
            {
              "key": "chatType",
              "value": "TEXT"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929383, //Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929383, //Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    이미지 답변(이미지)

    only image

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664170469355,
      "bubbles": [
        {
          "type": "carousel",
          "data": {
            "cards": [
              {
                "type": "template",
                "data": {
                  "cover": {
                    "type": "image",
                    "data": {
                      "imageUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                      "imagePosition": "top",
                      "action": {
                        "type": "link",
                        "data": {
                          "url": "https://ncloud.com"
                        }
                      }
                    }
                  }
                }
              }
            ]
          }
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929385, // Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929385, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    image + text

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664170681849,
      "bubbles": [
        {
          "type": "carousel",
          "data": {
            "cards": [
              {
                "type": "template",
                "data": {
                  "cover": {
                    "type": "image",
                    "title": "image title",
                    "data": {
                      "imageUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                      "description": "image description"
                    }
                  },
                  "contentTable": [
                    [
                      {
                        "rowSpan": 1,
                        "colSpan": 1,
                        "data": {
                          "type": "button",
                          "title": "display button1 name",
                          "data": {
                            "type": "basic",
                            "action": {
                              "type": "link",
                              "data": {
                                "url": "https://ncloud.com"
                              }
                            }
                          }
                        }
                      }
                    ],
                    [
                      {
                        "rowSpan": 1,
                        "colSpan": 1,
                        "data": {
                          "type": "button",
                          "title": "display button2 name",
                          "data": {
                            "type": "basic",
                            "action": {
                              "type": "link",
                              "data": {
                                "url": "https://fin-ncloud.com"
                              }
                            }
                          }
                        }
                      }
                    ]
                  ]
                },
                "information": [
                  {
                    "key": "carousel",
                    "value": "1"
                  },
                  {
                    "key": "chatType",
                    "value": "IMAGECARD"
                  },
                  {
                    "key": "imageOnly",
                    "value": "false"
                  },
                  {
                    "key": "chatType",
                    "value": "IMAGECARD"
                  },
                  {
                    "key": "score",
                    "value": "1.0"
                  },
                  {
                    "key": "scenarioName",
                    "value": "Conversation Name"
                  },
                  {
                    "key": "matchingType",
                    "value": "exactMatch"
                  },
                  {
                    "key": "domainCode",
                    "value": "Domain Code"
                  }
                ],
                "context": []
              }
            ]
          }
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929386, // Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929386, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    멀티링크 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664171090887,
      "bubbles": [
        {
          "type": "template",
          "data": {
            "cover": {
              "type": "text",
              "data": {
                "description": "Chatbot Answer"
              }
            },
            "contentTable": [
              [
                {
                  "rowSpan": 1,
                  "colSpan": 1,
                  "data": {
                    "type": "button",
                    "title": "Button Name",
                    "data": {
                      "type": "basic",
                      "action": {
                        "type": "link",
                        "data": {
                          "url": "https://ncloud.com"
                        }
                      }
                    }
                  }
                }
              ]
            ]
          },
          "information": [
            {
              "key": "chatType",
              "value": "MULTILINKS"
            },
            {
              "key": "chatType",
              "value": "MULTILINKS"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929384, // Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929384, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    폼 V1 (객관식) 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664171277095,
      "bubbles": [
        {
          "type": "template",
          "data": {
            "cover": {
              "type": "text",
              "data": {
                "description": "Chatbot Answer"
              }
            },
            "contentTable": [
              [
                {
                  "rowSpan": 1,
                  "colSpan": 1,
                  "data": {
                    "type": "button",
                    "title": "Button Name", // Use this value if you want the button name to be displayed.
                    "data": {
                      "type": "basic",
                      "action": {
                        "type": "postback",
                        "data": {
                          "postback": "Button Name",
                          "postbackFull": "_T_Button Name" // Use this value if you want a button action. 
                        }
                      }
                    }
                  }
                }
              ]
            ]
          },
          "information": [
            {
              "key": "imageOnly",
              "value": "false"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            },
            {
              "key": "formStart",
              "value": "true"
            },
            {
              "key": "serviceLinkedToForm",
              "value": ""
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929388, // Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929388, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    폼 V2 (객관식) 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664171884718,
      "bubbles": [
        {
          "type": "template",
          "data": {
            "cover": {
              "type": "text",
              "data": {
                "description": "Chatbot Answer"
              }
            },
            "contentTable": [
              [
                {
                  "rowSpan": 1,
                  "colSpan": 1,
                  "data": {
                    "type": "button",
                    "title": "Button Name",
                    "data": {
                      "type": "basic",
                      "action": {
                        "type": "postback",
                        "data": {
                          "postback": "UnexpiredForm\u241e47952\u241e0",
                          "displayText": "Button Name", // Use this value if you want the button name to be displayed.
                          "postbackFull": "_T_UnexpiredForm\u241e47952\u241e0" // Use this value if you want a button action.
                        }
                      }
                    }
                  }
                }
              ]
            ]
          },
          "information": [
            {
              "key": "imageOnly",
              "value": "false"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            },
            {
              "key": "formStart",
              "value": "true"
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929389, // Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929389, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    폼 V1 (Quick reply) 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664172269192,
      "bubbles": [
        {
          "type": "text",
          "data": {
            "description": "Chatbot Answer"
          },
          "information": [
            {
              "key": "imageOnly",
              "value": "false"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            },
            {
              "key": "formStart",
              "value": "true"
            },
            {
              "key": "serviceLinkedToForm",
              "value": ""
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929390, // Conversation ID
        "intent": []
      },
      "entities": [],
      "quickButtons": [
        {
          "type": "button",
          "title": "Button Name",
          "data": {
            "type": "basic",
            "action": {
              "type": "postback",
              "data": {
                "postback": "Button Name",
                "postbackFull": "_T_Button Name" // Use this value if you want a button action.
              }
            }
          }
        }
      ],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929390, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    폼 V2 (Quick reply) 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1664172948306,
      "bubbles": [
        {
          "type": "text",
          "data": {
            "description": "Chatbot Answer"
          },
          "information": [
            {
              "key": "imageOnly",
              "value": "false"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "chatType",
              "value": "SINGLEFORM"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            },
            {
              "key": "formStart",
              "value": "true"
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929393, // Conversation ID
        "intent": []
      },
      "entities": [],
      "quickButtons": [
        {
          "type": "button",
          "title": "Button Name",
          "data": {
            "type": "basic",
            "action": {
              "type": "postback",
              "data": {
                "postback": "UnexpiredForm\u241e47954\u241e0",
                "displayText": "Button Name", // Use this value if you want the button name to be displayed.
                "postbackFull": "_T_UnexpiredForm\u241e47954\u241e0" // Use this value if you want a button action.
              }
            }
          }
        }
      ],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929393, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    폼 주관식 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1665038738758,
      "bubbles": [
        {
          "type": "text",
          "data": {
            "description": "Chatbot Answer"
          },
          "information": [
            {
              "key": "chatType",
              "value": "TEXT"
            },
            {
              "key": "chatType",
              "value": "TEXT"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            },
            {
              "key": "formStart",
              "value": "true"
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929394, // Conversation ID
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929394, // Conversation ID
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    답변 없음 답변

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1665972966091,
      "bubbles": [
        {
          "type": "text",
          "data": {
            "description": ""
          },
          "information": [
            {
              "key": "chatType",
              "value": "NOANSWER"
            },
            {
              "key": "chatType",
              "value": "NOANSWER"
            },
            {
              "key": "score",
              "value": "1.0"
            },
            {
              "key": "scenarioName",
              "value": "Conversation Name"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            },
            {
              "key": "matchingType",
              "value": "exactMatch"
            },
            {
              "key": "domainCode",
              "value": "Domain Code"
            }
          ],
          "context": []
        }
      ],
      "scenario": {
        "name": "Conversation Name",
        "chatUtteranceSetId": 4929395,
        "intent": []
      },
      "entities": [],
      "keywords": [],
      "conversation": {
        "scenarioName": "Conversation Name",
        "chatUtteranceSetId": 4929395,
        "types": []
      },
      "normalizer": "null",
      "event": "send"
    }
    

    LINE Flex

    {
      "version": "v2",
      "userId": "U47b00b58c90f8e47428af8b7bddcda3d",
      "sessionId": "34a59946-5dcb-4b72-9b63-a773c659702e",
      "timestamp": 12345678,
      "bubbles": [
        {
          "type": "flex",
          "title": "this is a flex message",
          "data" : {
            "type": "bubble",
            "hero": {
              "type": "image",
              "url": "https://scdn.line-apps.com/n/channel_devcenter/img/fx/01_1_cafe.png",
              "size": "full",
              "aspectRatio": "20:13",
              "aspectMode": "cover",
            },
            "body": {
              "type": "box",
              "layout": "vertical",
              "contents": [
                {
                  "type": "text",
                  "text": "Brown Cafe",
                  "weight": "bold",
                  "size": "xl"
                }
              ]
            },
            "footer": {
              "type": "box",
              "layout": "vertical",
              "spacing": "sm",
              "contents": [
                {
                  "type": "button",
                  "style": "link",
                  "height": "sm",
                  "action": {
                    "type": "uri",
                    "label": "CALL",
                    "uri": "https://linecorp.com"
                  }
                },
                {
                  "type": "spacer",
                  "size": "sm"
                }
              ],
              "flex": 0
            }
          }
        }
      ],
      "event": "send"
    }
    

    LINE Sticker

    {
      "type": "line_sticker",
      "data": {
        "packageId": "446",
        "stickerId": "1988"
      },
      "information": [
        {
          "key": "chatType",
          "value": "STICKER"
        },
        {
          "key": "chatType",
          "value": "STICKER"
        },
        {
          "key": "tagInfo",
          "value": "platformExactMatch=line"
        },
        {
          "key": "score",
          "value": "1.0"
        },
        {
          "key": "scenarioName",
          "value": "Conversation Name"
        },
        {
          "key": "endOfBubble",
          "value": "endOfBubble"
        },
        {
          "key": "matchingType",
          "value": "exactMatch"
        },
        {
          "key": "domainCode",
          "value": "Domain Code"
        }
      ],
      "context": [],
      "event": "send"
    }
    

    Persistent Menu

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1665041597003,
      "bubbles": [],
      "persistentMenu": {
        "type": "template",
        "title": "3by2",
        "data": {
          "contentTable": [
            [
              {
                "rowSpan": 1,
                "colSpan": 1,
                "data": {
                  "type": "button",
                  "title": "",
                  "subTitle": "",
                  "data": {
                    "type": "imageButton",
                    "iconUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                    "action": {
                      "type": "link",
                      "data": {
                        "url": "https://ncloud.com",
                        "mobileUrl": "https://ncloud.com"
                      }
                    }
                  }
                }
              },
              {
                "rowSpan": 1,
                "colSpan": 1,
                "data": {
                  "type": "button",
                  "title": "",
                  "subTitle": "",
                  "data": {
                    "type": "imageButton",
                    "iconUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                    "action": {
                      "type": "link",
                      "data": {
                        "url": "https://guide.ncloud.com",
                        "mobileUrl": "https://guide.ncloud.com"
                      }
                    }
                  }
                }
              },
              {
                "rowSpan": 1,
                "colSpan": 1,
                "data": {
                  "type": "button",
                  "title": "",
                  "subTitle": "",
                  "data": {
                    "type": "imageButton",
                    "iconUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                    "action": {
                      "type": "link",
                      "data": {
                        "url": "https://console.ncloud.com",
                        "mobileUrl": "https://console.ncloud.com"
                      }
                    }
                  }
                }
              }
            ],
            [
              {
                "rowSpan": 1,
                "colSpan": 1,
                "data": {
                  "type": "button",
                  "title": "",
                  "subTitle": "",
                  "data": {
                    "type": "imageButton",
                    "iconUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                    "action": {
                      "type": "utterance",
                      "data": {
                        "utteranceId": 4934527,
                        "text": "\ub77c\uc778\ud50c\ub809\uc2a4", // Use this value if you want the button name to be displayed.
                        "postback": "_U_4934527" // Use this value if you want a button action.
                      }
                    }
                  }
                }
              },
              {
                "rowSpan": 1,
                "colSpan": 1,
                "data": {
                  "type": "button",
                  "title": "",
                  "subTitle": "",
                  "data": {
                    "type": "imageButton",
                    "iconUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                    "action": {
                      "type": "utterance",
                      "data": {
                        "utteranceId": 4934526,
                        "text": "image name", // Use this value if you want the button name to be displayed.
                        "postback": "_U_4934526" // Use this value if you want a button action.
                      }
                    }
                  }
                }
              },
              {
                "rowSpan": 1,
                "colSpan": 1,
                "data": {
                  "type": "button",
                  "title": "",
                  "subTitle": "",
                  "data": {
                    "type": "imageButton",
                    "iconUrl": "https://clovachatbot.ncloud.com/i48103278ci6f6-9f51-4d08-a947-1c8acc992629",
                    "action": {
                      "type": "utterance",
                      "data": {
                        "utteranceId": 4929395,
                        "text": "image name", // Use this value if you want the button name to be displayed.
                        "postback": "_U_4929395" // Use this value if you want a button action.
                      }
                    }
                  }
                }
              }
            ]
          ]
        }
      },
      "keywords": [],
      "conversation": {
        "scenarioName": null,
        "chatUtteranceSetId": null,
        "types": []
      },
      "slotNormalizer": {},
      "normalizer": "",
      "event": "send"
    }
    

    Welcome Message

    {
      "version": "v2",
      "userId": "Usss47b00b58c90f8e47428af8b7bddcda3d",
      "timestamp": 1665043071864,
      "bubbles": [
        {
          "type": "text",
          "data": {
            "description": "Chatbot Answer"
          },
          "information": [
            {
              "key": "chatType",
              "value": "TEXT"
            },
            {
              "key": "chatType",
              "value": "TEXT"
            },
            {
              "key": "defaultMsgType",
              "value": "welcomeMsg"
            },
            {
              "key": "welcomeMsgId",
              "value": "6277"
            },
            {
              "key": "endOfBubble",
              "value": "endOfBubble"
            }
          ]
        }
      ],
      "entities": [],
      "persistentMenu": "persistentMenu, optional",
      "keywords": [],
      "conversation": {
        "scenarioName": null,
        "chatUtteranceSetId": null,
        "types": []
      },
      "event": "open"
    }
    

    이 문서가 도움이 되었습니까?

    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.