- 印刷する
- PDF
Basic
- 印刷する
- PDF
Classic/VPC環境で利用できます。
チャットボット返答のレスポンスコンポーネントのうち、Basicコンポーネントについて説明します。
Basicコンポーネントは、次の3つの基本コンポーネントで構成されます。
- Text
- Image
- Button (ButtonコンポーネントはQuick Buttonsコンポーネントを含みます)
上記のコンポーネントはそれぞれの特徴に合わせてチャットボットのレスポンスをチャットボットビルダで設定することができ、チャットボットビルダで設定したレスポンス結果を JSON形式で返します。
Textコンポーネント
Textコンポーネントは、タイトル(Title)、サブタイトル(Sub Title)、説明(Description)、URLで構成されます。
Textコンポーネントのレスポンスボディ
Textコンポーネントのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | コンポーネントのタイプ
|
title | String | Optional | コンポーネントのタイトル
|
subTitle | String | Optional | 下位コンポーネントのタイトル
|
data | Object | Optional | テキスト(Text)コンポーネントの構成情報 |
data.description | String | Optional | コンポーネントの詳細説明
|
data.url | String | Optional | コンポーネントのハイパーリンク URL
|
data.urlAlias | String | Optional | コンポーネントハイパーリンク URLのエイリアス
|
data.action | Action | Optional | コンポーネントアクション(Action)情報
|
Textコンポーネントのレスポンス例
Textコンポーネントのレスポンスのサンプルコードは次の通りです。
{
"type": "text",
"title": "optional, short bold text",
"subTitle": "optional, short gray text",
"data" :
{
"description" : "optional, a long text content",
"url" : "optional, a hyperlink at the bottom of description",
"urlAlias" :"optional, hyperlink show this alias",
"action": {Action Data}
}
}
Imageコンポーネント
Imageコンポーネントは、画像とともにタイトル(Title)、サブタイトル(Sub Title)、説明(Description)、URLで構成されます。
Imageコンポーネントのレスポンスボディ
Imageコンポーネントのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | コンポーネントのタイプ
|
title | String | Optional | コンポーネントのタイトル
|
subTitle | String | Optional | 下位コンポーネントのタイトル
|
data | Object | Optional | 画像(Image)コンポーネントの構成情報 |
data.imageUrl | String | Required | 画像の URL
|
data.alt | String | Optional | 画像説明のツールチップ
|
data.imagePosition | String | Optional | 画像の位置
|
data.description | String | Optional | 画像の詳細説明 |
data.url | String | Optional | 画像のハイパーリンク URL
|
data.urlAlias | String | Optional | 画像ハイパーリンク URLのエイリアス
|
data.action | Action | Optional | コンポーネントアクション(Action)情報
|
Imageコンポーネントのレスポンス例
Imageコンポーネントのレスポンスのサンプルコードは次の通りです。
{
"type": "image",
"title": "optional, short bold text",
"subTitle": "optional, short gray text",
"data" :
{
"imageUrl" : "https://ssl.pstatic.net/CloudFunctions.png",
"alt" : "optional, short hint show when hover on image",
"imagePosition" : "top",
"description" : "optional, details info of image",
"url" : "optional, a hyperlink at the bottom of description",
"urlAlias" : "optional, hyperlink show this alias",
"action": {Action Data}
}
}
Buttonコンポーネント
Buttonコンポーネントは、画像とともにタイトル(Title)、サブタイトル(Sub Title)、説明(Description)、URLでボタン(Button)を構成します。Quick Buttonコンポーネントも Buttonコンポーネントに含まれます。
Buttonコンポーネントのレスポンスボディ
Buttonコンポーネントのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | コンポーネントのタイプ
|
title | String | Optional | コンポーネントのタイトル
|
subTitle | String | Optional | 下位コンポーネントのタイトル
|
data | String | Required | ボタン(Button)コンポーネントの構成情報 |
data.type | String | Required | ボタンの種類
|
data.iconUrl | String | Optional | ボタンアイコン URL
|
data.action | Action | Optional | コンポーネントアクション(Action)情報
|
Buttonコンポーネントのレスポンス例
Buttonコンポーネントのレスポンスのサンプルコードは次の通りです。
Basic Button
Basic Buttonのレスポンスのサンプルコードは次の通りです。
{
"type": "button",
"title": "optional, text show on button",
"subTitle": "optional, short gray text",
"data" :
{
"type": "basic",
"iconUrl" : "https://ssl.pstatic.net/CloudFunctions.png",
"action": {Action Data}
}
}
Image Button
Image Buttonのレスポンスのサンプルコードは次の通りです。
{
"type": "button",
"title": "optional, text show on button",
"subTitle": "optional, short gray text",
"data" :
{
"type": "imageButton",
"iconUrl" : "https://ssl.pstatic.net/CloudFunctions.png",
"action": {Action Data}
}
}
Quick Buttonsコンポーネント
Quick Buttonsコンポーネントを説明します。チャット画面下部にあるグループ固定ボタンです。button
コンポーネントに含まれます。
Quick Buttonsのレスポンスボディ
Quick Buttonsnのレスポンスボディは次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | コンポーネントのタイプ
|
title | String | Optional | コンポーネントの名前 |
data | Object | Optional | コンポーネントの構成情報 |
data.type | String | Conditional | コンポーネントのタイプ
|
data.action | Object | Conditional | コンポーネントのアクション(Action)情報 |
data.action.type | String | Conditional | コンポーネントアクションのタイプ
|
data.action.data | Object | Conditional | コンポーネントアクション(Action)の詳細情報
|
data.action.data.postback | String | Conditional | チャットボットにポストバックしたテキスト |
data.action.data.displayText | String | Conditional | チャットボットに表示されるクイックボタン(Quick Button)の名前 |
data.action.data.postbackFull | String | Conditional | クイックボタン実行のためにチャットボットにポストバックしたテキスト |
Quick Buttonsのレスポンス例
Quick Buttonsnのレスポンスのサンプルコードは次の通りです。
{
"quickButtons": [
{
"type": "button",
"title": "Button Name",
"data": {
"type": "basic",
"action": {
"type": "postback",
"data": {
"postback": "UnexpiredForm\u241e47954\u241e0",
"displayText": "Button Name",
"postbackFull": "_T_UnexpiredForm\u241e47954\u241e0"
}
}
}
}
]
}