---
title: "Open"
slug: "ai-application-service-chatbot-open"
tags: ["CLOVA Chatbot"]
updated: 2026-04-23T08:55:35Z
published: 2026-04-23T09:02:17Z
canonical: "api.ncloud-docs.com/ai-application-service-chatbot-open"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Open

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

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

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

* Basic Component
* Composite Component
* Flex Component

* 컴포넌트에 대한 자세한 내용은 [Basic 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-basic), [Composite 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-composite), [Flex 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-flex)를 참조해 주십시오.
:::


## 요청 <a name="요청"></a>
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| :--- | :--- |
| POST | CLOVA Chatbot 빌더에서 생성된 API Gateway의 고유 InvokeURL |

### 요청 헤더 <a name="요청헤더"></a>
CLOVA Chatbot API에서 공통으로 사용하는 헤더에 대한 정보는 [CLOVA Chatbot 요청 헤더](/docs/ai-application-service-chatbot#요청헤더)를 참조해 주십시오.

### 요청 바디 <a name="요청바디"></a>
요청 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `version` | String | Optional | 챗봇 버전 <ul><li>`v1` \| `v2` (기본값)<ul><li>미입력 시 `v1` 설정</li></ul></li></ul> |
| `userId` | String | Required | 챗봇 사용자 고유 아이디<ul><li>최대 256자 이내 임의 입력</li></ul> |
| `userIp` | String | Optional | 사용자 IP 주소 |
| `timestamp`| Long | Required | 임의의 타임 스탬프 값(Timestamp) |
| `bubbles` | Array | Required | 비어 있는 배열 또는 [Welcome 컴포넌트](/docs/ai-application-service-chatbot-action#Welcome컴포넌트)로 생성된 1개의 [Text 컴포넌트](/docs/ai-application-service-chatbot-basic#Text컴포넌트)<ul><li>[bubbles 상세 정보](#bubble) 참조</li></ul> |
| `event` | String | Required | 이벤트 값<ul><li>`open`으로 설정 </li></ul> |

#### `bubble` <a name="bubble"></a>
`bubble`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `type` | String | Required | 컴포넌트 유형<ul><li>`text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| </li><li>각 컴포넌트에 대한 자세한 내용은 [Basic 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-basic), [Composite 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-composite), [Flex 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-flex) 참조</li></ul> |
| `data` | Object | Required | 컴포넌트 구성 정보 |
| `data.description` | String | Required | 컴포넌트 상세 설명 |

### 요청 예시 <a name="요청예시"></a>
요청 예시는 다음과 같습니다.

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

## 응답 <a name="응답"></a>
응답 형식을 설명합니다.

### 응답 바디 <a name="응답바디"></a>
응답 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `version` | String | - | 챗봇 버전 <ul><li>`v1` \| `v2` <ul><li>요청 시 입력하지 않으면 `v1`으로 응답됨</li></ul></li></ul> |
| `userId` | String | - | 챗봇 사용자 고유 아이디<ul><li>요청 시 설정한 `userId` 값과 동일</li></ul> |
| `timestamp` | Long | -  | 타임 스탬프 값(Timestamp) |
| `bubbles` | Array | - | bubbles 상세 정보: [bubbles](#bubbles)<ul><li>응답 컴포넌트의 배열</li><li>각 컴포넌트는 챗봇의 응답 버블(Bubble)과 매치됨</li></ul> |
| `entities` | Array | - | 사용자의 질의에 일치된 챗봇 엔티티 (Entity) 분석 결과 |
| `persistentMenu`| Object | - | 고정 메뉴(Persistent Menu) 정보<ul><li>자세한 설명은 [PersistentMenu 컴포넌트](/docs/ai-application-service-chatbot-composite#PersistentMenu컴포넌트) 참조</li></ul> |
| `keywords` | Array | - | keywords 상세 정보: [keywords](#keywords)<ul><li>`exactMatch` \| `contain`<ul><li>`exactMatch`: 사용자 입력 값과 키워드가 일치</li><li>`contain`: 사용자 입력 값에 키워드가 포함</li></ul></li></ul> |
| `conversation` | Object | - | 대화 구성 정보 |
| `conversation.scenarioName` | String | - | 시나리오 이름 |
| `conversation.chatUtteranceSetId` | String | - | 대화 발화 아이디 |
| `conversation.types` | Array | - | 대화 유형 |
| `code` | String | - | 오류 코드<ul><li>챗봇 질의에 실패했을 경우 표시</li><li>`500`</li></ul> |
| `message` | String | - | 오류 메시지<ul><li>챗봇 질의에 실패했을 경우 표시</li><li>`Internal server error`</li></ul> |
| `timestamp` | String | - | 응답 시간(Timestamp)<ul><li>챗봇 질의에 실패했을 경우 표시</li></ul> |
| `event` | String | - | 이벤트 값 |

#### `bubbles` <a name="bubbles"></a>
`bubbles`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `type` | String | - | 컴포넌트 유형<ul><li>`text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| </li><li>각 컴포넌트에 대한 자세한 내용은 [Basic 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-basic), [Composite 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-composite), [Flex 컴포넌트 상세 정보](/docs/ai-application-service-chatbot-flex) 참조</li></ul> |
| `data` | Object | - | 컴포넌트 구성 정보 |
| `data.description` | String | - | 컴포넌트 상세 설명 | 
| `information` | Array | - | information 상세 정보: [information](#information) |

#### `information` <a name="information"></a>
`information`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `key` | String | - | 데이터 키 |
| `value` | String | - | 데이터 값 |

#### `keywords` <a name="keywords"></a>
`keywords`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `keyword` | String | - | 키워드 |
| `group` | String | - | 키워드 그룹 |
| `type` | String | - | 키워드 종류 |


### 응답 상태 코드 <a name="응답상태코드"></a>
CLOVA Chatbot API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [CLOVA Chatbot 응답 상태 코드](/docs/ai-application-service-chatbot#응답상태코드)를 참조해 주십시오.

### 응답 예시 <a name="응답예시"></a>
응답 예시는 다음과 같습니다.

```json
{
    "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"
}
```