Open

Classic/VPC環境で利用できます。

チャットボットにウェルカムメッセージが設定されている場合、APIを呼び出したときに自動的にウェルカムメッセージを返します。

参考

チャットボット返答のレスポンスコンポーネントは次の3つの種類のコンポーネントを提供します。

Basic Component
Composite Component
Flex Component
コンポーネントの詳細は、Basicコンポーネントの詳細情報、Compositeコンポーネントの詳細情報、Flexコンポーネントの詳細情報をご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	CLOVA Chatbotビルダで作成された API Gatewayの固有の InvokeURL

リクエストヘッダ

CLOVA Chatbot Custom APIで共通して使用されるヘッダの詳細は、CLOVA Chatbot Custom APIの共通ヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	String	Optional	チャットボットのバージョン `v1` \| `v2`(デフォルト) 入力しない場合は`v1`に設定
`userId`	String	Required	チャットボットユーザーの固有の ID 256文字以内で任意に入力
`userIp`	String	Optional	ユーザー IPアドレス
`timestamp`	Long	Required	任意のタイムスタンプ(Timestamp)
`bubbles`	Array	Required	空状態の配列またはWelcomeコンポーネントで作成された1つのTextコンポーネント bubblesの詳細情報を参照
`event`	String	Required	イベントの値 `open`に設定

`bubble`

bubbleの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	Required	コンポーネントのタイプ `text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| 各コンポーネントの詳細はBasicコンポーネントの詳細情報、Compositeコンポーネントの詳細情報、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	Optional	チャットボットのバージョン `v1` \| `v2` リクエスト時に入力しない場合、`v1`が返される
`userId`	String	Required	チャットボットユーザーの固有の ID リクエスト時に設定した`userId`値と同じ
`timestamp`	Long	Required	タイムスタンプ(Timestamp)
`bubbles`	Array	Required	bubblesの詳細情報レスポンスコンポーネントの配列各コンポーネントはチャットボットのレスポンスバブル(Bubble)とマッチされる
`entities`	Array	Optional	ユーザーの質問と一致するチャットボットエンティティ(Entity)の分析結果
`persistentMenu`	Object	Optional	固定メニュー(Persistent Menu)情報詳細はPersistentMenuコンポーネントを参照
`keywords`	Array	Optional	keywordsの詳細情報 `exactMatch` \| `contain` `exactMatch`: ユーザーの入力値とキーワードが一致 `contain`: ユーザーの入力値にキーワードが含まれる
`conversation`	Object	Optional	会話の構成情報
`conversation.scenarioName`	String	Conditional	シナリオ名
`conversation.chatUtteranceSetId`	String	Conditional	会話発話 ID
`conversation.types`	Array	Conditional	会話タイプ
`code`	String	Conditional	エラーコードチャットボット質問に失敗した場合に表示 `500`
`message`	String	Conditional	エラーメッセージチャットボット質問に失敗した場合に表示 `Internal server error`
`timestamp`	String	Conditional	レスポンスタイム(Timestamp) チャットボット質問に失敗した場合に表示
`event`	String	Required	イベントの値

`bubbles`

bubblesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	Required	コンポーネントのタイプ `text` \| `image` \| `button` \| `template` \| `carousel` \| `flex` \| `line_sticker` \| `lineworks_sticker` \| 各コンポーネントの詳細はBasicコンポーネントの詳細情報、Compositeコンポーネントの詳細情報、Flexコンポーネントの詳細情報を参照
`data`	Object	Optional	コンポーネントの構成情報
`data.description`	String	Conditional	コンポーネントの詳細説明
`information`	Array	Optional	informationの詳細情報

`information`

bubbles.informationの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`key`	String	Conditional	データキー
`value`	String	Conditional	データの値

`keywords`

keywordsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`keyword`	String	Conditional	キーワード
`group`	String	Conditional	キーワードグループ
`type`	String	Conditional	キーワードの種類

レスポンスステータスコード

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"
}