MENU
      Open

        Open


        기사 요약

        Classic/VPC 환경에서 이용 가능합니다.

        챗봇에 웰컴 메시지가 설정되어 있는 경우 API를 호출했을 때 자동으로 웰컴 메시지를 응답합니다.

        참고

        챗봇 답변의 응답 컴포넌트는 다음 3가지 형태의 컴포넌트를 제공합니다.

        요청

        요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

        메서드URI
        POSTCLOVA Chatbot 빌더에서 생성된 API Gateway의 고유 InvokeURL

        요청 헤더

        CLOVA Chatbot Custom API에서 공통으로 사용하는 헤더에 대한 정보는 CLOVA Chatbot Custom API 공통 헤더를 참조해 주십시오.

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        versionStringOptional챗봇 버전
        • v1 | v2 (기본값)
          • 미입력 시 v1 설정
        userIdStringRequired챗봇 사용자 고유 아이디
        • 최대 256자 이내 임의 입력
        userIpStringOptional사용자 IP 주소
        timestampLongRequired임의의 타임 스탬프 값(Timestamp)
        bubblesArrayRequired비어 있는 배열 또는 Welcome 컴포넌트로 생성된 1개의 Text 컴포넌트
        eventStringRequired이벤트 값
        • open으로 설정

        bubble

        bubble에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        typeStringRequired컴포넌트 유형
        dataObjectRequired컴포넌트 구성 정보
        data.descriptionStringRequired컴포넌트 상세 설명

        요청 예시

        요청 예시는 다음과 같습니다.

        {
        "version": "v2",
        "userId": "{userId}",
        "userIp": "{userIp}",
        "timestamp": 12345678,
        "bubbles": [
            {
                "type": "text",
                "data" :
                {
                    "description" : "postback text of welcome action"
                }
            }
        ],
        "event": "open"
        }
        JSON

        응답

        응답 형식을 설명합니다.

        응답 바디

        응답 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        versionStringOptional챗봇 버전
        • v1 | v2
          • 요청 시 입력하지 않으면 v1으로 응답됨
        userIdStringRequired챗봇 사용자 고유 아이디
        • 요청 시 설정한 userId 값과 동일
        timestampLongRequired타임 스탬프 값(Timestamp)
        bubblesArrayRequiredbubbles 상세 정보
        • 응답 컴포넌트의 배열
        • 각 컴포넌트는 챗봇의 응답 버블(Bubble)과 매치됨
        entitiesArrayOptional사용자의 질의에 일치된 챗봇 엔티티 (Entity) 분석 결과
        persistentMenuObjectOptional고정 메뉴(Persistent Menu) 정보
        keywordsArrayOptionalkeywords 상세 정보
        • exactMatch | contain
          • exactMatch: 사용자 입력 값과 키워드가 일치
          • contain: 사용자 입력 값에 키워드가 포함
        conversationObjectOptional대화 구성 정보
        conversation.scenarioNameStringConditional시나리오 이름
        conversation.chatUtteranceSetIdStringConditional대화 발화 아이디
        conversation.typesArrayConditional대화 유형
        codeStringConditional오류 코드
        • 챗봇 질의에 실패했을 경우 표시
        • 500
        messageStringConditional오류 메시지
        • 챗봇 질의에 실패했을 경우 표시
        • Internal server error
        timestampStringConditional응답 시간(Timestamp)
        • 챗봇 질의에 실패했을 경우 표시
        eventStringRequired이벤트 값

        bubbles

        bubbles에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        typeStringRequired컴포넌트 유형
        dataObjectOptional컴포넌트 구성 정보
        data.descriptionStringConditional컴포넌트 상세 설명
        informationArrayOptionalinformation 상세 정보

        information

        bubbles.information에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        keyStringConditional데이터 키
        valueStringConditional데이터 값

        keywords

        keywords에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        keywordStringConditional키워드
        groupStringConditional키워드 그룹
        typeStringConditional키워드 종류

        응답 상태 코드

        CLOVA Chatbot Custom API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 CLOVA Chatbot Custom API 공통 응답 상태 코드를 참조해 주십시오.

        응답 예시

        응답 예시는 다음과 같습니다.

        {
            "version":"v2",
            "userId":"{userId}",
            "timestamp":1725842214334,
            "bubbles":[
                {
                "type":"text",
                "data":{
                    "description":"안녕하세요.\n궁금한 점을 챗봇에게 물어보세요."
                    },
                    "information":[
                        {"key":"chatType", "value":"TEXT"},
                        {"key":"chatType", "value":"TEXT"},
                        {"key":"defaultMsgType", "value":"welcomeMsg"},
                        {"key":"welcomeMsgId", "value":"20727"},
                        {"key":"endOfBubble", "value":"endOfBubble"}
                    ]
                }
            ],
            "entities":[],
            "persistentMenu":
            {
                "type":"template",
                "title":"PersistentMenu",
                "data":
                {
                    "contentTable":[
                        [
                            {
                                "rowSpan":1,
                                "colSpan":1,
                                "data":
                                    {
                                        "type":"button",
                                        "title":"PersistentMenu1",
                                        "subTitle":"",
                                        "data":
                                            {
                                                "type":"basic",
                                                "action":
                                                    {
                                                        "type":"utterance",
                                                        "data":
                                                            {
                                                                "utteranceId":5560752,
                                                                "text":"PersistentMenu1",
                                                                "postback":"_U_5560752"
                                                            }
        }}}}]]}},
            "keywords":[],
            "conversation":
                {
                    "scenarioName":null,
                    "chatUtteranceSetId":null,
                    "types":[]
                },
            "event":"open"
        }
        JSON

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

        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.