--- title: "Open" slug: "ai-application-service-chatbot-open" tags: ["CLOVA Chatbot"] updated: 2026-09-17T09:35:51Z published: 2026-09-17T09:35:51Z 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 Available in Classic and VPC If the chatbot has a welcome message set up, it will automatically respond with a welcome message when the API is called. Note The following three types of response components are available for chatbot answers. - Basic Component - Composite Component - Flex Component - For more information about components, see [Basic component details](/docs/en/ai-application-service-chatbot-component-basic), [Composite component details](/docs/en/ai-application-service-chatbot-component-composite), and [Flex component details](/docs/en/ai-application-service-chatbot-component-flex). ## Request The following describes the request format for the endpoint. The request format is as follows: | Method | URI | | --- | --- | | POST | API Gateway's unique invoke URL created in CLOVA Chatbot Builder | ### Request headers For headers common to all CLOVA Chatbot APIs, see [CLOVA Chatbot request headers](/docs/en/ai-application-service-chatbot#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94). ### Request body The following describes the request body. | Field | Type | Required | Description | | --- | --- | --- | --- | | `version` | String | Optional | Chatbot version - `v1` \| `v2` (default) - Set to `v1` when not entered | | `userId` | String | Required | Unique chatbot user ID - Any input up to 256 characters | | `userIp` | String | Optional | User IP address | | `timestamp` | Long | Required | Arbitrary timestamp value (timestamp) | | `bubbles` | Array | Required | Empty array or 1 [Text component](/docs/en/ai-application-service-chatbot-component-basic#Text%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8) created with the [Welcome component](/docs/en/ai-application-service-chatbot-component-commonaction#Welcome%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8) - See [bubbles details](/docs/en/ai-application-service-chatbot-open#bubble) | | `event` | String | Required | Event value - Set to `open` | #### `bubble` The following describes `bubble`. | Field | Type | Required | Description | | --- | --- | --- | --- | | `type` | String | Required | Component type - `text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| - For more information each component, see [Basic component details](/docs/en/ai-application-service-chatbot-component-basic), [Composite component details](/docs/en/ai-application-service-chatbot-component-composite), and [Flex component details](/docs/en/ai-application-service-chatbot-component-flex) | | `data` | Object | Required | Component configuration information | | `data.description` | String | Required | Detailed Descriptions of Components | ### Request example The following is a sample request. ``` { "version": "v2", "userId": "{userId}", "userIp": "{userIp}", "timestamp": 12345678, "bubbles": [ { "type": "text", "data" : { "description" : "postback text of welcome action" } } ], "event": "open" } ``` ## Response The following describes the response format. ### Response body The following describes the response body. | Field | Type | Required | Description | | --- | --- | --- | --- | | `version` | String | - | Chatbot version - `v1` \| `v2` - Respond with `v1` if not entered on request | | `userId` | String | - | Unique chatbot user ID - Same as the `userId` value set on request | | `timestamp` | Long | - | Timestamp value (timestamp) | | `bubbles` | Array | - | bubbles details: [bubbles](/docs/en/ai-application-service-chatbot-open#bubbles) - Array of response components - Each component is matched with a response bubble in the chatbot | | `entities` | Array | - | Chatbot entity analysis results that matched the user's query | | `persistentMenu` | Object | - | Persistent menu information - See [PersistentMenu component](/docs/en/ai-application-service-chatbot-component-composite#PersistentMenu%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8) for more information | | `keywords` | Array | - | keywords details: [keywords](/docs/en/ai-application-service-chatbot-open#keywords) - `exactMatch` \| `contain` - `exactMatch`: User input matches keywords - `contain`: User input contains keywords | | `conversation` | Object | - | Conversation configuration information | | `conversation.scenarioName` | String | - | Scenario name | | `conversation.chatUtteranceSetId` | String | - | Conversation utterance ID | | `conversation.types` | Array | - | Conversation type | | `code` | String | - | Error code - It is displayed when a chatbot query fails - `500` | | `message` | String | - | Error message - It is displayed when a chatbot query fails - `Internal server error` | | `timestamp` | String | - | Error time (timestamp) - It is displayed when a chatbot query fails | | `event` | String | - | Event value | #### `bubbles` The following describes `bubbles`. | Field | Type | Required | Description | | --- | --- | --- | --- | | `type` | String | - | Component type - `text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| - For more information each component, see [Basic component details](/docs/en/ai-application-service-chatbot-component-basic), [Composite component details](/docs/en/ai-application-service-chatbot-component-composite), and [Flex component details](/docs/en/ai-application-service-chatbot-component-flex) | | `data` | Object | - | Component configuration information | | `data.description` | String | - | Detailed Descriptions of Components | | `information` | Array | - | information details: [information](/docs/en/ai-application-service-chatbot-open#information) | #### `information` The following describes `information`. | Field | Type | Required | Description | | --- | --- | --- | --- | | `key` | String | - | Data key | | `value` | String | - | Data value | #### `keywords` The following describes `keywords`. | Field | Type | Required | Description | | --- | --- | --- | --- | | `keyword` | String | - | Keywords | | `group` | String | - | Keyword group | | `type` | String | - | Keyword type | ### Response status codes For response status codes common to all CLOVA Chatbot APIs, see [CLOVA Chatbot response status codes](/docs/en/ai-application-service-chatbot#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C). ### Response example The following is a sample example. ``` { "version":"v2", "userId":"{userId}", "timestamp":1725842214334, "bubbles":[ { "type":"text", "data":{ "description":"Hello.\nAsk any questions to the chatbot." }, "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" } ```