Image Carousel

An image carousel message displays image items in order in multiple columns,
which can be scrolled horizontally.

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.

The following figure shows the image carousel structure.

structure_image_carousel

Request content {#image-carousel-request}

common {#image-carousel-request-common}

ParameterTypeRequiredDescription
typestringYSet this parameter to "image_carousel".
columnsarrayYList of image carousel objects
Maximum number: 10 objects
columns[].originalContentUrlstringYImage URL (PNG format, HTTPS only)
Either originalContentUrl or fileId, but not both, must be specified (required).
Maximum size: 1 MB
Maximum length: 1,000 characters
columns[].fileIdstringNImage file ID.
Either originalContentUrl or fileId, but not both, must be specified (required).
Maximum size: 1 MB
columns[].actionAction ObjectNAction that occurs when the image is pressed

multi language {#image-carousel-request-multilang}

ParameterTypeRequiredDescription
columns[].i18nOriginalContentUrls[]arrayNList of multilingual image URLs
columns[].i18nOriginalContentUrls[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
columns[].i18nOriginalContentUrls[].originalContentUrlstringYImage URL (PNG format, HTTPS only)
Maximum size: 1 MB
Maximum length: 1,000 characters
columns[].i18nFileIds[]arrayNList of multilingual image file IDs
columns[].i18nFileIds[].languagestringYLanguage code
• ko_KR • ja_JP • zh_CN • zh_TW • en_US
columns[].i18nFileIds[].fileIdstringYImage file ID.
Maximum size: 1 MB

Request example {#image-carousel-request-example}

example_image_carousel

{     "content":{        "type":"image_carousel",      "columns":[           {              "originalContentUrl":"https://example.com/example.png",            "action":{                 "type":"uri",               "label":"Visit",               "uri":"https://example.com"            }         },         {              "originalContentUrl":"https://example.com/example.png",            "action":{                 "type":"uri",               "label":"Visit",               "uri":"https://example.com"            }         },         {              "originalContentUrl":"https://static.worksmobile.net/static/wm/botprofile/Bot_General_640.png",            "action":{                 "type":"uri",               "label":"Talk",               "uri":"https://example.com"            }         }      ]   }}