Learn about the Rich Content object used by the Automation Framework and Bot v3 API
Rich content refers to some external document or media file that supporting networks can display in special ways. For example, images and videos can be displayed inline, or links to articles can be supplied along with an image to display inline.
When sending a richContent object in the /bots/v3/respond JSON payload, we recommend also including the text field as a fallback in case the rich content isn't supported.
{
"mediaType": "IMAGE",
"url": "https://www.example.com/article.html",
"title": "some title",
"mediaUrl": "https://www4.example.com/cool_pic_to_display.jpg",
"mimeType": "image/jpeg"
}
| Field | Description |
|---|---|
| mediaType | Required. A type like IMAGE or VIDEO. |
| url | Required. A URL of a resource to which the end user will be redirected if they click the rich content/link. |
| title | Required. A title for the content at url. |
| mediaUrl | Required. A URL of a media resource like an image or video. Handling may be network-specific. |
| mimeType | Required. The MIME type of the resource at mediaUrl. |