Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Show

The Show action is responsible for rendering content to devices with screens.

At its most basic, a show action instructs the end device to display its body text verbatim. The show action may also wrap several properties that allow users to describe common output fields, such as subject, body, and images. These can be used to describe text with more detail to allow richer output on devices that support it.

Simple example: Show text

{
	"actions": [
		{
			"show": {
				"body": "Hello World!"
			}
		}
	]
}

Rich example: Display text and an image

{
	"actions": [
		{
			"show": {
				"body": "Order: 1 Large Coffee",
				"subject":"Summary",
				"images": [ {
				    "label": "small",
				    "url": "https://megacoffe.ai/large_coffee.png"
				    
				}]
			}
		}
	]
}

Body

Body is a property of the Show action. The text defined by a Body property is used as the main text body for end devices that support richer text output formats. For simpler formats, the body is the only data displayed.

Subject

Subject is a property of the Show action. Text in a Subject property is used as the subject or title text on end devices that support richer text output formats. For simpler formats, subject is ignored.

Images

Images is a list property of the Show action. Images specify images to attach to richer output formats. Every object has two attributes: url which points to a jpg or png file, and label which is an optional tag that can be used for slotting into rich media formats with specific positioning slots.

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.