Action Objects
メンバーがトークのボタンや画像を押した際の Bot の動作を定義します。
action objectは次のトークで使用されます。
- メッセージ送信 > メッセージ共通プロパティ > Quick Reply
- メッセージ送信(Button Template)
- メッセージ送信(List Template)
- メッセージ送信(Carousel)
- メッセージ送信(Image Carousel)
- 固定メニュー
- リッチメニュー
使用可能な動作は次の通りです。
- postback action
- message action
- URI action
- camera action
- camera roll action
- location action
- copy action
Postback Action
この動作はカルーセル、画像カルーセル、リッチメニュー、クイック返信(quick reply)の項目のみ指定できます。この動作が指定されている項目が押されると、「data」パラメータに指定された文字列を含む postback event を callback として返します。
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "postback" |
| label | string | - | 項目のラベル リッチメニューとカルーセルの「defaultAction」項目を除き必須。リッチメニューで値を指定しない場合、デスクトップ版 アプリ ではデフォルトのメッセージを表示。 最大20文字 (画像カルーセルのみ最大 12 文字) |
| data | string | Y | postback.data プロパティとして返す文字列 最大 300 文字 |
| displayText | string | - | トーク画面に表示されるテキスト。入力しない場合、テキストが表示されない。 クイック返信では必須。 最大 300 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | 項目のラベル 最大 20 文字 (画像カルーセルのみ最大 12 文字) |
| i18nDisplayTexts | array | N | 多言語の表示テキストリスト |
| i18nDisplayTexts[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nDisplayTexts[].displayText | string | Y | トーク画面に表示されるテキスト 最大 300 文字 |
Request Example
{
"type": "postback",
"label": "Buy",
"data": "action=buy&itemid=111",
"displayText": "Buy"
}
Message Action
この動作が指定されている項目を押すと、「text」プロパティの文字列がメッセージとして送信されます。
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "message" |
| label | string | - | 項目のラベル。リッチメニューとカルーセルの「defaultAction」を除き必須。リッチメニューで値を指定しない場合、デスクトップ環境ではデフォルトのメッセージを表示。 ●基本 : 最大 20 文字 ●画像カルーセル : 最大 12 文字 ●固定メニュー : 最大 1,000 文字 |
| text | string | - | 項目を押した時に送信されるテキスト カルーセル、画像カルーセル、リッチメニュー、クイック返信では必須。ボタンテンプレート、リストテンプレート、固定メニューでは label 値に置き換えられる。 最大 300 文字 |
| postback | string | N | message.postback プロパティに返される文字列 最大文字数：1,000 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | 項目のラベル ●基本 : 最大 20 文字 ●画像カルーセル : 最大 12 文字 ●固定メニュー : 最大 1,000 文字 |
| i18nTexts | array | N | 多言語のテキストリスト |
| i18nTexts[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nTexts[].text | string | Y | 項目を押した時に送信されるテキスト カルーセル、画像カルーセル、リッチメニュー、クイック返信では必須。ボタンテンプレート、リストテンプレート、固定メニューではlabel値に置き換えられる。 最大 300 文字 |
Request Example
{
"type": "message",
"label": "Yes",
"text": "Yes"
}
URI Action
この動作が指定されている項目を押すと、「uri」プロパティで指定された URI が開きます。
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "uri" |
| label | string | - | 項目のラベル。リッチメニューとカルーセルの「defaultAction」を除き必須。リッチメニューで値を指定しない場合、デスクトップ環境ではデフォルトのメッセージを表示。 ●基本 : 最大 20 文字 ●画像カルーセル : 最大 12 文字 ●固定メニュー : 最大 1,000 文字 |
| uri | string | Y | 項目を押した時に開く URI。「http」「https」スキーマのみ対応。 最大 1,000 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | 項目のラベル ●基本 : 最大 20 文字 ●画像カルーセル : 最大 12 文字 ●固定メニュー : 最大 1,000 文字 |
Request Example
{
"type": "uri",
"label": "View details",
"uri": "http://www.worksmobile.com"
}
Camera Action
この動作が指定されているボタンを押すと、カメラを開きます。この動作はクイック返信のみ指定できます。
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "camera" |
| label | string | Y | ボタンのラベル 最大 20 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | ボタンのラベル 最大 20 文字 |
Request Example
{
"type": "camera",
"label": "Camera"
}
Camera Roll Action
この動作が指定されているボタンを押すと、カメラロール画面を開きます。この動作はクイック返信のみ指定できます。
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "cameraRoll" |
| label | string | Y | ボタンのラベル 最大 20 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | ボタンのラベル 最大 20 文字 |
Request Example
{
"type": "cameraRoll",
"label": "Camera roll"
}
Location Action
この動作が指定されているボタンを押すと、マップを開きます。この動作はクイック返信のみ指定できます。
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "location" |
| label | string | Y | ボタンのラベル 最大 20 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | ボタンのラベル 最大 20 文字 |
Request Example
{
"type": "location",
"label": "Location"
}
Copy Action
この動作に関連する項目をクリックすると、「copyText」プロパティに指定されたテキストがクリップボードにコピーされる。（v3.6以上対応）
common
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | "copy" |
| label | string | - | 項目のラベル。リッチメニューとカルーセルの「defaultAction」を除き必須。リッチメニューで値を指定しない場合、デスクトップ環境ではデフォルトのメッセージを表示。 ●基本 : 最大 20 文字 ●画像カルーセル : 最大 12 文字 ●固定メニュー : 最大 1,000 文字 |
| copyText | string | Y | 項目をクリックするとクリップボードにコピーされる。 最大 1,000 文字 |
multi language
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| i18nLabels | array | N | 多言語のラベルリスト |
| i18nLabels[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
| i18nLabels[].label | string | Y | 項目のラベル ●基本 : 最大 20 文字 ●画像カルーセル : 最大 12 文字 ●固定メニュー : 最大 1,000 文字 |
Request Example
{
"type": "copy",
"label": "Copy This",
"copyText": "This is a copied text."
}