List Template

Makes a bot send a list template message.

You can use a button on the template message to add the postback parameter to a message, which then the server can receive as a callback. For more information, see Receive Messages (Callback).

A message to send can be written in multiple languages. Then, it will be displayed in the language that matches the client device's language settings.

An image can be sent by using a URL or a file ID. Using a URL: Only HTTPS is allowed. Using a file ID: The file ID returned when the content is uploaded is used to send messages.

The following figure shows the list template structure.

structure_list

Note

  • Whenever a file ID is used to send a list template message, the recipient's shared storage will be reduced by the size of the image.
  • A list template can have up to 4 elements.
  • Up to 2 x 2 buttons (in 2 rows and 2 columns) can be added in the lower part of a list template.

Request content {#list-request}

common {#list-request-common}

ParameterTypeRequiredDescription
typestringYSet this parameter to "list_template".
coverDataobjectNData to be included in the cover data.
coverData.backgroundImageUrlstringNURL for the background image of cover data (PNG format, HTTPS only)
Either backgroundImageUrl or backgroundFileId, but not both, can be specified (optional).
Maximum length: 1,000 characters
coverData.backgroundFileIdstringNFile ID for the background image of cover data
Either backgroundImageUrl or backgroundFileId, but not both, can be specified (optional).
Maximum size: 1 MB
coverData.titlestringNTitle of cover data
Maximum length: 1,000 characters
coverData.subtitlestringNSubtitle of cover data
Maximum length: 1,000 characters
elementsarrayYElements to be added to the list template
elements[].titlestringYTitle of each element
Maximum length: 1,000 characters
elements[].subtitlestringNSubtitle of each element
Maximum length: 1,000 characters
elements[].originalContentUrlstringNURL of the image of each element (PNG format, HTTPS only)
Either originalContentUrl or fileId, but not both, can be specified (optional).
Maximum length: 1,000 characters
elements[].fileIdstringNFile ID for the image of each element.
Either originalContentUrl or fileId, but not both, can be specified (optional).
Maximum size: 1 MB
elements[].actionarray<Action Object>NButton to be used in each element
actions[][]array<array<Action Object>>NButtons to be located in the lower part. The first and second arrays represent rows and columns respectively.

multi language {#list-request-multilang}

ParameterTypeRequiredDescription
coverData.i18nBackgroundImageUrls[]arrayNList of URLs for the background images of multilingual cover data
coverData.i18nBackgroundImageUrls[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
coverData.i18nBackgroundImageUrls[].backgroundImageUrlstringYURL for the background image of multilingual cover data (PNG format, HTTPS only)
Maximum length: 1,000 characters
coverData.i18nBackgroundFileIds[]arrayNList of file IDs for the background images of multilingual cover data
coverData.i18nBackgroundFileIds[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
coverData.i18nBackgroundFileIds[].backgroundFileIdstringYFile ID for the background image of multilingual cover data.
Maximum size: 1 MB
coverData.i18nTitles[]arrayNList of multilingual cover data titles
coverData.i18nTitles[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
coverData.i18nTitles[].titlestringYTitle of multilingual cover data
Maximum length: 1,000 characters
coverData.i18nSubtitles[]arrayNList of multilingual cover data subtitles
coverData.i18nSubtitles[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
coverData.i18nSubtitles[].subtitlestringYSubtitle of multilingual cover data
Maximum length: 1,000 characters
elements[].i18nTitles[]arrayNList of multilingual element titles
elements[].i18nTitles[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
elements[].i18nTitles[].titlestringYTitle of each multilingual element
Maximum length: 1,000 characters
elements[].i18nSubtitles[]arrayNList of multilingual element subtitles
elements[].i18nSubtitles[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
elements[].i18nSubtitles[].subtitlestringYSubtitle of each multilingual element
Maximum length: 1,000 characters
elements[].i18nOriginalContentUrls[]arrayNList of multilingual element image URLs
elements[].i18nOriginalContentUrls[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
elements[].i18nOriginalContentUrls[].originalContentUrlstringYURL of the image of each element in the language (PNG format, HTTPS only)
Maximum length: 1,000 characters
elements[].i18nFileIds[]arrayNList of file IDs for multilingual element images
elements[].i18nFileIds[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
elements[].i18nFileIds[].fileIdstringYFile ID for each multilingual element image.
Maximum size: 1 MB

Request example {#list-request-example}

example_list

{  "content": {    "type": "list_template",    "coverData": {      "backgroundImageUrl": "https://example.com/example.png"    },    "elements": [{      "title": "Homepage",      "subtitle": "Press the button to visit.",      "action": {        "type": "uri",        "label": "Visit",        "uri": "https://example.com/example.png"      }    }, {      "title": "FAQ",      "subtitle": "Talk with bot.",      "originalContentUrl": "https://example.com/example.png",      "action": {        "type": "message",        "label": "Talk",        "postback": "ListTemplate_Talk"      }    }],    "actions": [[{      "type": "message",      "label": "View more",      "postback": "ListTempalte_ViewMore"    }]]  }}