リストテンプレート
トーク Bot を使ってリストテンプレートを送信します。
メンバーがボタンを押すと、ボタンラベルのテキストと postback で指定したメッセージが Bot 受信サーバーに送信されます。メッセージの形式については Callback (メッセージの受信) を参照してください。
リストテンプレートは多言語に対応しており、メンバーの言語設定に合わせて表示を切り替えることができます。
画像の指定には URL 方式とファイル ID 方式があります。URL 方式は HTTPS のみ対応しています。 ファイル ID 方式では、 事前にコンテンツアップロード API を使って取得したファイル ID を使って画像を送信します。
リストテンプレートの構成は下図の通りです。
参考
- ファイル ID 方式で画像を指定すると、アップロードした画像は共有ストレージを消費します。
- リストテンプレートのアイテムは最大 4 個まで登録できます。
- リストテンプレート下部のボタンは最大 2 列、2 行まで登録できます。
Request Content {#list-request}
common {#list-request-common}
| パラメータ | タイプ | 説明 |
|---|---|---|
| type | string | "list_template" required |
| coverData | object | カバーデータ |
| coverData.backgroundImageUrl | string | カバーデータ背景画像の URL (PNG 形式、HTTPS のみ) backgroundImageUrl、backgroundFileId のいずれかを選択。 最大 1,000 字 |
| coverData.backgroundFileId | string | カバーデータ背景画像のファイル ID backgroundImageUrl、backgroundFileId のいずれかを選択。 最大サイズ： 1 MB |
| coverData.title | string | カバーデータのタイトル 最大 1,000 字 |
| coverData.subtitle | string | サブタイトル 最大 1,000 字 |
| elements | array<object> | アイテムリスト required |
| elements[].title | string | アイテムのタイトル 最大 1,000 字 required |
| elements[].subtitle | string | アイテムのサブタイトル 最大 1,000 字 |
| elements[].originalContentUrl | string | アイテム画像の URL (PNG 形式、 HTTPS のみ) originalContentUrl、fileId のいずれかを選択。 最大 1,000 字 |
| elements[].fileId | string | アイテム画像のファイル ID originalContentUrl、fileId のいずれかを選択 最大サイズ： 1 MB |
| elements[].action | array<Action Object> | 各アイテムのボタン |
| actions[][] | array<array<Action Object>> | 下部のボタン 1つ目の配列は行、2つ目の配列は列を表す |
multi language {#list-request-multilang}
| パラメータ | タイプ | 説明 |
|---|---|---|
| coverData.i18nBackgroundImageUrls[] | array | 多言語のカバーデータ背景画像の URL リスト |
| coverData.i18nBackgroundImageUrls[].language | string | 言語コード required |
| coverData.i18nBackgroundImageUrls[].backgroundImageUrl | string | カバーデータ背景画像の URL (PNG 形式、HTTPS のみ可能) 最大 1,000 字 required |
| coverData.i18nBackgroundFileIds[] | array | 多言語のカバーデータ背景画像のファイル ID リスト |
| coverData.i18nBackgroundFileIds[].language | string | 言語コード required |
| coverData.i18nBackgroundFileIds[].backgroundFileId | string | カバーデータ背景画像のファイル ID 最大サイズ： 1 MB required |
| coverData.i18nTitles[] | array | 多言語のカバーデータのタイトルリスト |
| coverData.i18nTitles[].language | string | 言語コード required |
| coverData.i18nTitles[].title | string | カバーデータのタイトル 最大 1,000 字 required |
| coverData.i18nSubtitles[] | array | 多言語のカバーデータのサブタイトルリスト |
| coverData.i18nSubtitles[].language | string | 言語コード required |
| coverData.i18nSubtitles[].subtitle | string | カバーデータのサブタイトル 最大 1,000 字 required |
| elements[].i18nTitles[] | array | 多言語のアイテムのタイトルリスト |
| elements[].i18nTitles[].language | string | 言語コード required |
| elements[].i18nTitles[].title | string | アイテムのタイトル 最大 1,000 字 required |
| elements[].i18nSubtitles[] | array | 多言語の各アイテムのサブタイトルリスト |
| elements[].i18nSubtitles[].language | string | 言語コード required |
| elements[].i18nSubtitles[].subtitle | string | 各アイテムのサブタイトル 最大 1,000 字 required |
| elements[].i18nOriginalContentUrls[] | array | 多言語のアイテムの画像 URL リスト |
| elements[].i18nOriginalContentUrls[].language | string | 言語コード required |
| elements[].i18nOriginalContentUrls[].originalContentUrl | string | アイテム画像の URL (PNG 形式、HTTPS のみ) 最大 1,000 字 required |
| elements[].i18nFileIds[] | array | 多言語のアイテム画像のファイル ID リスト |
| elements[].i18nFileIds[].language | string | 言語コード required |
| elements[].i18nFileIds[].fileId | string | アイテム画像のファイル ID 最大サイズ： 1 MB required |
Request Example {#list-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-works.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" }]] }}