Overview

Rich card messages combine an image, header, text, and a button into a single, visually appealing card. The header displays at the top of the card, followed by the image, text and button. All rich card messages are categorized as promotional.

Rules and restrictions

The following restrictions apply for using a rich card:

Field	Required	Remarks
header	Yes	Displayed as the title. Maximum length is 30 characters.
text	No	Displayed as the subtitle. Maximum length is 900 characters.
mediaUri	No	The URL of the image to display.
suggestions	No	Suggestions as buttons. Maximum of 1 button per card.

The following actions are supported by Viber as rich card buttons:

Action	Remarks
OpenURL	Maximum length of label is 30 characters, URL required.
Dial	Maximum length of label is 30 characters, phone number required.

Rich card message example

In the example below, we send a message that contains rich card properties. The rich card is composed of a header, a text, an image and a suggestion button.

{
  "messages": {
    "msg": [
      {
        "from": "Your sender",
        "to": [
          {
            "number": "Phone number"
          }
        ],
        "allowedChannels": [
          "Viber", "SMS"
        ],
        "body": {
          "type": "auto",
          "content": "SMS fallback Text"
        },
        "richContent": {
          "conversation": [
            {
              "header": "We are CM.com!",
              "text": "Visit our website or start a chat with one of our employee's!",
              "media": {
                "mediaUri": "https://www.cm.com/cdn/cm/cm.png",
                "mimeType": "image/png",
                "mediaName": "cm.png"
              },
              "suggestions": [
                {
                  "action": "OPENURL",
                  "label": "Visit our website!",
                  "url": "https://www.cm.com",
                  "postbackdata": "WEBSITE"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}