Card Message

A card message is a message that features a formatted card. Depending on the channel, the card can contain an image or a video. The card can contain choices to display text, a URL, a location, or make a call. You can send a card message by making a POST request to the /messages:send Conversation API endpoint with the following payload:

{
  "app_id": "{{APP_ID}}",
  "recipient": {
    "contact_id": "{{CONTACT_ID}}"
  },
  "message": {
    "card_message": {
      "title": "Sign up for our newsletter",
      "description": "Our weekly newsletter is filled with deals and extra content!",
        "media_message": {
          "url": "https://1vxc0v12qhrm1e72gq1mmxkf-wpengine.netdna-ssl.com/wp-content/uploads/2019/05/Sinch-logo-Events.png"
        },
        "choices": [
         {
           "text_message": {
              "text": "Sign up here"
          }
        }
      ]
    }
  }
}

The follow sections give examples of how card messages are rendered in each channel.

WhatsApp

WhatsApp channel provides a limited native support for card messages. If you only include text choices in your card message then Conversation API is able to use a rich message format on WhatsApp. Otherwise your message will be transcoded as a media message with plaintext caption.

Media support in CardMessage:

  • image or video media will be displayed as rich content (see supported image and video types at Media Messages)
  • audio or sticker media will be included as plaintext link on the card due to a limitation of the WhatsApp Business API
  • document media has a conditional support, it can be displayed as rich content when all the choices are Text (see the example above), otherwise it will be a plaintext link in the card

The following image gives an example of a card message.

Card Message

SMS

SMS channel doesn't natively support card messages. Messages are sent in plain text. The following image gives an example of a card message.

Card Message

Facebook Messenger

Facebook Messenger natively supports Card Messages. The media_message property only supports images. The following image gives an example of a card message.

Card Message

Instagram

Instagram natively supports card messages.

Note

Only image media are supported for Instagram cards.

MMS

MMS natively supports Card messages.

The following image gives an example of a card message.

Card Message

RCS

RCS natively supports Card Messages with a maximum of 3 choices. The media message in the Card should point to an image or a video. The following image gives an example of a card message.

Card Message With URL Choice

Viber Bot

Viber Bot channel natively supports card messages. The following image gives an example of a card message.

Card Message

Viber Business Messages

Viber Business Messages supports natively Card messages with one URL, Call, or Location choice. The media message in the Card should point to an image. The title of the choice in the Card message has a maximum length of 30 characters, longer content will be truncated.

The following image gives an example of a card message.

Card Message

Telegram

Telegram channel natively supports card messages with one media content. The following image gives an example of a card message.

Card Message

Kakaotalk

Kakaotalk supports Card messages natively.

Note

Card messages on Kakaotalk only support png and jpg image media types.

Media included in the Media message will be rejected by the channel if:

  • the width is below 500px, or if the 'width:length' ratio is below 2:1, or above 3:4 or if the image dimension is not equal to [800px * 600px] (so called wide image)
  • image file format is different than JPG or PNG
  • file size is bigger than 500KB or for image with dimension [800px * 600px] is bigger than 2MB

The concatenated title and descritpion text of the Card message has a maximum length of:

  • 1000 characters (if Card message doesn't contain Media message)
  • 400 characters (if Card message contains Media message)
  • 76 characters (if Card message contains Media message with wide image)

The title of the choice in the Card message has a maximum length of 14 characters.

The Card message can have only one choice in case Media message is a wide image.