List Template
トーク Bot を使ってリストテンプレートを送信します。
メンバーがボタンを押すと、ボタンラベルのテキストと postback で指定したメッセージが Bot 受信サーバーに送信されます。 メッセージの形式については「メッセージ (Callback) 受信」を参照してください。
リストテンプレートは多言語に対応しており、メンバーの言語設定に合わせて表示を切り替えることができます。
画像の指定には URL 方式とファイル ID 方式があります。 URL 方式は HTTPS のみ対応しています。 ファイル ID 方式の場合、 事前にコンテンツアップロード API を使って取得したファイルIDを使って画像を送信します。
リストテンプレートの構成は下図の通りです。
参考
- ファイル ID 方式で画像を指定すると、アップロードした画像は共有ストレージを消費します。
- リストテンプレートのアイテムは最大 4 個まで登録できます。
- リストテンプレート下部のボタンは最大 2 列、2 行まで登録できます。
Request Content
common
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
type | string | Y | "list_template" |
coverData | object | N | カバーデータ |
coverData.backgroundImageUrl | string | N | カバーデータ背景画像の URL (PNG 形式、 HTTPS のみ)。 backgroundImageUrl、backgroundFileId のいずれかを選択。 最大 1,000 字 |
coverData.backgroundFileId | string | N | カバーデータ背景画像のファイル ID。 backgroundImageUrl、backgroundFileId のいずれかを選択。 |
coverData.title | string | N | カバーデータのタイトル 最大 1,000 字 |
coverData.subtitle | string | N | サブタイトル 最大 1,000 字 |
elements | array<object> | Y | アイテムリスト |
elements[].title | string | Y | アイテムのタイトル 最大 1,000 字 |
elements[].subtitle | string | N | アイテムのサブタイトル 最大 1,000 字 |
elements[].originalContentUrl | string | N | アイテム画像の URL (PNG 形式、 HTTPS のみ) originalContentUrl、fileIdのいずれかを選択。 最大 1,000 字 |
elements[].fileId | string | N | アイテム画像のファイル ID。 originalContentUrl、fileIdのいずれかを選択。 |
elements[].action | array<Action Object> | N | 各アイテムのボタン。 |
actions[][] | array<array<Action Object>> | N | 下部のボタン。1つ目の配列は行、2つ目の配列は列を表す。 |
multi language
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
coverData.i18nBackgroundImageUrls[] | array | N | 多言語のカバーデータ背景画像の URL リスト |
coverData.i18nBackgroundImageUrls[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
coverData.i18nBackgroundImageUrls[].backgroundImageUrl | string | Y | カバーデータ背景画像の URL (PNG 形式、 HTTPS のみ可能) 最大 1,000 字 |
coverData.i18nBackgroundFileIds[] | array | N | 多言語のカバーデータ背景画像のファイル ID リスト |
coverData.i18nBackgroundFileIds[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
coverData.i18nBackgroundFileIds[].backgroundFileId | string | Y | カバーデータ背景画像のファイル ID。 |
coverData.i18nTitles[] | array | N | 多言語のカバーデータのタイトルリスト |
coverData.i18nTitles[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
coverData.i18nTitles[].title | string | Y | カバーデータのタイトル 最大 1,000 字 |
coverData.i18nSubtitles[] | array | N | 多言語のカバーデータのサブタイトルリスト |
coverData.i18nSubtitles[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
coverData.i18nSubtitles[].subtitle | string | Y | カバーデータのサブタイトル 最大 1,000 字 |
elements[].i18nTitles[] | array | N | 多言語のアイテムのタイトルリスト |
elements[].i18nTitles[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
elements[].i18nTitles[].title | string | Y | アイテムのタイトル 最大 1,000 字 |
elements[].i18nSubtitles[] | array | N | 多言語の各アイテムのサブタイトルリスト |
elements[].i18nSubtitles[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
elements[].i18nSubtitles[].subtitle | string | Y | 各アイテムのサブタイトル 最大 1,000 字 |
elements[].i18nOriginalContentUrls[] | array | N | 多言語のアイテムの画像 URL リスト |
elements[].i18nOriginalContentUrls[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
elements[].i18nOriginalContentUrls[].originalContentUrl | string | Y | アイテム画像の URL (PNG 形式、 HTTPS のみ) 最大 1,000 字 |
elements[].i18nFileIds[] | array | N | 多言語のアイテム画像のファイル ID リスト |
elements[].i18nFileIds[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
elements[].i18nFileIds[].fileId | string | Y | アイテム画像のファイル ID。 |
Request Example
{
"content": {
"type": "list_template",
"coverData": {
"backgroundImageUrl": "https://example.com/1.png"
},
"elements": [{
"title": "LINE WORKS Homepage",
"subtitle": "Press the button to visit.",
"action": {
"type": "uri",
"label": "Visit",
"uri": "https://line.worksmobile.com"
}
}, {
"title": "FAQ",
"subtitle": "Talk with bot.",
"originalContentUrl": "https://example.com/2.png",
"action": {
"type": "message",
"label": "Talk",
"postback": "ListTemplate_Talk"
}
}],
"actions": [[{
"type": "message",
"label": "View more",
"postback": "ListTempalte_ViewMore"
}]]
}
}