Templates

This page lists each template, its template-specific parameters, and its recommended channels. These parameters are in addition to those for any request to the API.

NOTE:

For a full list that defines both these parameters and others that are common to any API request regardless of the template used, go to POST /v1/omnichannel.

text

Recommended For
all channels

Send a simple text-only message.

object
message
object
required

media

Recommended For
RCS

Send a message to an end-user that includes an embedded image, audio file, or video file.

object
message
object
required

url_action

Recommended For
RCS

Send a message to an end-user that includes a link button to a URL of your choice.

object
message
object
required

rc_url_action_vertical

Recommended For
RCS

Send a message to an end-user that displays a vertically stacked rich card, including both an image and a link button to a URL of your choice.

object
message
object
required

rc_url_action_horizontal

Recommended For
RCS

Send a message to an end-user that displays a horizontally arranged rich card, including both an image and a link button to a URL of your choice.

object
message
object
required

dial_action

Recommended For
RCS

Send a message to an end-user that includes a button they can select to initiate a voice call.

object
message
object
required

rc_dial_action_vertical

Recommended For
RCS

Send a message to an end-user that displays a vertically stacked rich card, including both an image and a click-to-call button.

object
message
object
required

rc_dial_action_horizontal

Recommended For
RCS

Send a message to an end-user that displays a horizontally arranged rich card, including both an image and a click-to-call button.

object
message
object
required

2_suggested_replies

Recommended For
RCS

Send a message to an end-user that includes a question and two buttons, each of which suggests a reply for them to choose from.

object
message
object
required

3_suggested_replies

Recommended For
RCS

Send a message to an end-user that includes a question and three buttons, each of which suggests a reply for them to choose from.

object
message
object
required

image

Recommended For
WhatsApp
MMS

Send a message to an end-user that includes an embedded image.

object
message
object
required

video

Recommended For
WhatsApp
MMS

Send a message to an end-user that includes an embedded video.

object
message
object
required

audio

Recommended For
WhatsApp
MMS

Send a message to an end-user that includes embedded audio.

object
message
object
required

file

Recommended For
WhatsApp

Send a message to an end-user that includes an attached file for them to open or download. This file is hosted by you.

object
message
object
required

location

Recommended For
WhatsApp

Send a message to an end-user that includes latitude and longitude coordinates for a geographical location.

object
message
object
required