Skip to main content
Version: 1.10.0

Gallery

This chapter will explain: what are card and gallery, as well as how to create and use them on the platform.

In addition to message types such as text and image messages, you may want the agent to send richer responses in conversations. For example, card messages supported on different channels: custom-responses

The gallery brings together the platform preset cards and custom cards, where you can add, delete, modify and search for cards. These card templates can be used directly in agent responses. All you need to do is to modify the corresponding item values according to business. For details, see Configure response with gallery.

Preset card: Cards provided by the platform.

Custom card: Cards created by the user, which includes cards created directly on the platform, and cards imported to the platform.

Preset card

  1. Click "Build - Custom Configs - Gallery" to enter the page. In the initial state, only the preset cards provided by the platform are displayed. Displayed items are cover, name and copy JSON button. no-card

  2. Hover over the card cover or name of the card to preview it. preview-preset-card

  3. Click the card cover or name to check configurations. Displayed items are name, JSON, Preview. You can click the corresponding button to copy the code or the JSON. preset-card-configs

note

Preset cards cannot be modified or deleted.

Custom card

How to create a custom card

  1. Click "+ CREATE", choose the "Create" tab, set the card name and JSON format card content. create-card

  2. Once created, the cards will be displayed after the preset cards in the order of creation, from last to first. Displayed items are cover, name and copy JSON button.

    • Cards created directly on the platform will use a default image as the cover.
    • Custom cards do not support hovering on the cover or name to preview.

has-created-card

tip

The card content must be written in JSON format. It is recommended to mark the item values that can be modified when creating for future use.

{
content: 'CARD_NAME',
content: 'CARD_CONTENT'
}

How to import a custom card

  1. Click "+ CREATE", choose the "Import" tab and upload the .zip file (maximum 50MB). The name of the .zip file will be used as the default name of the card, which can be modified later. upload-card
caution

Listed below are the files needed in the .zip file:

zip

File NameFile FormatAdditional Info
template.jsonJSON format card content
distFolderindex.js (i.e. card component resources) should be included in this folder
previewSupport .jpg, .jpeg, .png, .svg, .bmp file(Optional) Card cover

Please make sure the file names and formats are the same as required in the table. Otherwise, the parsing will fail.

  1. Once created, the cards will be displayed after the preset cards in the order of creation, from last to first. Displayed items are cover, name, copy JSON button and copy CODE button.
    • If the "preview" file exists, it will be used as the card cover.
    • If the "preview" file cannot be found, a default image will be used as the card cover.
    • Custom cards do not support hovering on the cover or name to preview.

has-uploaded-card

Configurations & Operations

  1. Click the card cover or name to check configurations. Displayed items are listed as below:
TypeDisplayed Item NameAdditional Info
Cards created directly on the platform1. Card Name
2. Card Content
1. Card name can be modified
2. Card content can be modified
Cards imported to the platform1. Card Name
2. Integration code
3. Card Content
1. Card name can be modified
2. You can click the corresponding button to copy the card code or JSON

custom-card-configs

  1. Click the "Delete" button to delete the card.
note

Though the card has been deleted from gallery, the corresponding responses in skills can still work in conversations.

Click the "+ Add Response" button of the skill configuration drawer, all the cards added to gallery will be displayed under the "Gallery" type. For preset cards, you can hover over the name to preview it. hover-preview

Configure response with preset card

  1. Preset cards support visual configuration. visual-config

  2. Operations:

Button NameAdditional Info
Copy Card-
Copy Button-
Add Button1. Configurable for specific cards
2. Maximum 5 buttons for preset card 1
Add Main Button1. Configurable for specific cards
2. Maximum 3 buttons for preset card 2
Add SEC Button1. Configurable for specific cards
2. Maximum 3 buttons for preset card 2
Add Card1. When there are multiple cards, they will be displayed as a carousel in conversations
2. Maximum 10 cards

When there are multiple cards or buttons, you can click the icon shown in the gif to fold them for better experience。 fold-item

To delete a card or a button, click "x" on the right side of the configurations. delete-item

  1. Card configuration items:
Item NameAdditional Info
TitleMaximum 24 characters
SubtitleMaximum 100 characters
ImageSupport .jpg, .jpeg, .png, .svg, .bmp file
Button TextConfigurable for specific cards, maximum 24 characters
Main Button TextConfigurable for specific cards, maximum 24 characters
SEC Button TextConfigurable for specific cards, maximum 24 characters
Button ColorConfigurable for specific cards
Button Text ColorConfigurable for specific cards
Main Button ColorConfigurable for specific cards
Main Button Text ColorConfigurable for specific cards
SEC Button Border ColorConfigurable for specific cards
SEC Button Text ColorConfigurable for specific cards
Button TypeCurrently, we support two types:
1. Send message: click the button, the button text will be sent as a text message to the agent
2. Open URL: click the button, the configured URL will be opened on a new page
Metadata1. Metadata can only be used in one dialogue
2. You need to set both the key and the value

Configure response with custom card

When choosing a custom card, the corresponding JSON format card content will be displayed. You can modify the corresponding item values according to business needs. json-config

tip

Slots and Metadata can be used to render the response both for preset cards and custom cards. The platform will render the places configured as {slot = SLOT_NAME} and {metadata = METADATA_NAME} as the corresponding values.

Index of custom messages provided by commonly used channels

Here is a table of the agent custom message documentation provided by commonly used channels for your reference.

ChannelDocumentation
Larkhttps://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-card/overview
Teamshttps://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference
Enterprise Wechathttps://developer.work.weixin.qq.com/document/path/90236
Ding Talkhttps://open.dingtalk.com/document/orgapp-server/message-types-and-data-format
Cisco Webexhttps://developer.webex.com/docs/api/guides/cards