--- title: "Open" slug: "ai-application-service-chatbot-open" tags: ["CLOVA Chatbot"] updated: 2026-09-17T09:57:17Z published: 2026-09-17T09:57: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 Classic/VPC環境で利用できます。 チャットボットにウェルカムメッセージが設定されている場合、APIを呼び出したときに自動的にウェルカムメッセージを返します。 参考 チャットボット返答のレスポンスコンポーネントは次の3つの種類のコンポーネントを提供します。 - Basic Component - Composite Component - Flex Component - コンポーネントの詳細は、[Basicコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-basic)、[Compositeコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-composite)、[Flexコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-flex)をご参照ください。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | POST | CLOVA Chatbotビルダで作成された API Gatewayの固有の InvokeURL | ### リクエストヘッダ CLOVA Chatbot APIで共通して使用されるヘッダの詳細は、[CLOVA Chatbotのリクエストヘッダ](/docs/ja/ai-application-service-chatbot#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストボディ リクエストボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `version` | String | Optional | チャットボットのバージョン - `v1` \| `v2`(デフォルト) - 入力しない場合は`v1`に設定 | | `userId` | String | Required | チャットボットユーザーの固有の ID - 256文字以内で任意に入力 | | `userIp` | String | Optional | ユーザー IPアドレス | | `timestamp` | Long | Required | 任意のタイムスタンプ(Timestamp) | | `bubbles` | Array | Required | 空状態の配列または[Welcomeコンポーネント](/docs/ja/ai-application-service-chatbot-component-commonaction#Welcome%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8)で作成された1つの[Textコンポーネント](/docs/ja/ai-application-service-chatbot-component-basic#Text%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8) - [bubblesの詳細情報](/docs/ja/ai-application-service-chatbot-open#bubble)を参照 | | `event` | String | Required | イベントの値 - `open`に設定 | #### `bubble` `bubble`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `type` | String | Required | コンポーネントのタイプ - `text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| - 各コンポーネントの詳細は[Basicコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-basic)、[Compositeコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-composite)、[Flexコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-flex)を参照 | | `data` | Object | Required | コンポーネントの構成情報 | | `data.description` | String | Required | コンポーネントの詳細説明 | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` { "version": "v2", "userId": "{userId}", "userIp": "{userIp}", "timestamp": 12345678, "bubbles": [ { "type": "text", "data" : { "description" : "postback text of welcome action" } } ], "event": "open" } ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `version` | String | - | チャットボットのバージョン - `v1` \| `v2` - リクエスト時に入力しない場合、`v1`が返される | | `userId` | String | - | チャットボットユーザーの固有の ID - リクエスト時に設定した`userId`値と同じ | | `timestamp` | Long | - | タイムスタンプ(Timestamp) | | `bubbles` | Array | - | bubblesの詳細情報: [bubbles](/docs/ja/ai-application-service-chatbot-open#bubbles) - レスポンスコンポーネントの配列 - 各コンポーネントはチャットボットのレスポンスバブル(Bubble)とマッチされる | | `entities` | Array | - | ユーザーの質問と一致するチャットボットエンティティ(Entity)の分析結果 | | `persistentMenu` | Object | - | 固定メニュー(Persistent Menu)情報 - 詳細は[PersistentMenuコンポーネント](/docs/ja/ai-application-service-chatbot-component-composite#PersistentMenu%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8)を参照 | | `keywords` | Array | - | keywordsの詳細情報: [keywords](/docs/ja/ai-application-service-chatbot-open#keywords) - `exactMatch` \| `contain` - `exactMatch`: ユーザーの入力値とキーワードが一致 - `contain`: ユーザーの入力値にキーワードが含まれる | | `conversation` | Object | - | 会話の構成情報 | | `conversation.scenarioName` | String | - | シナリオ名 | | `conversation.chatUtteranceSetId` | String | - | 会話発話 ID | | `conversation.types` | Array | - | 会話タイプ | | `code` | String | - | エラーコード - チャットボット質問に失敗した場合に表示 - `500` | | `message` | String | - | エラーメッセージ - チャットボット質問に失敗した場合に表示 - `Internal server error` | | `timestamp` | String | - | レスポンスタイム(Timestamp) - チャットボット質問に失敗した場合に表示 | | `event` | String | - | イベントの値 | #### `bubbles` `bubbles`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `type` | String | - | コンポーネントのタイプ - `text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| - 各コンポーネントの詳細は[Basicコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-basic)、[Compositeコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-composite)、[Flexコンポーネントの詳細情報](/docs/ja/ai-application-service-chatbot-component-flex)を参照 | | `data` | Object | - | コンポーネントの構成情報 | | `data.description` | String | - | コンポーネントの詳細説明 | | `information` | Array | - | informationの詳細情報: [information](/docs/ja/ai-application-service-chatbot-open#information) | #### `information` `information`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `key` | String | - | データキー | | `value` | String | - | データの値 | #### `keywords` `keywords`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `keyword` | String | - | キーワード | | `group` | String | - | キーワードグループ | | `type` | String | - | キーワードの種類 | ### レスポンスステータスコード CLOVA Chatbot APIで共通して使用されるレスポンスステータスコードの詳細は、[CLOVA Chatbot Custom APIのレスポンスステータスコード](/docs/ja/ai-application-service-chatbot#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 ``` { "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" } ```