Text Message

Hey there! 👋 Those fresh Nike kicks you were eyeing are practically flying off the shelves! Imagine the spring in your step and the envious glances you'll get rocking the latest innovation in comfort and style. Don't miss out on experiencing the ultimate fusion of performance and street cred. Tap here to grab your pair before they're gone! 🔥👟

Overview

A text message is a simple message that contains only text.

Properties
  • Text
  • Suggestions
Text
Required
  • Maximum 3072 characters
  • Special characters, such as emoji or a multi-byte character set, count as 2–4 characters or more.
Suggestions
Optional
  • Maximum 11 suggestions
Learn More:
Official Documentation

Rich Card Standalone

Media

Nike Vomero 18

Maximum cushioning in the Vomero provides a comfortable ride for everyday runs. Our softest, most cushioned ride has lightweight ZoomX foam stacked on top of responsive ReactX foam in the midsole.

Properties
  • Media
  • Title
  • Description
  • Suggestions (Replies and Actions)

Note: Each of these fields is optional, but at least one of the fields Media, Title or Description must be included in the rich card.

Layout Orientation

VERTICAL or HORIZONTAL

Vertical Rich Card
Media height:
  • SHORT: 112 DP
  • MEDIUM: 168 DP
  • TALL: 264 DP
Media aspect ratio:
  • 2:1
  • 16:9
  • 7:3
Horizontal Rich Card
Dimensions:
  • Width: 128 DP
  • Media orientation: LEFT or RIGHT
Media height:
  • The height scales to the height of the text elements in the card.
Media aspect ratio:
  • A horizontal rich card doesn't have a fixed media ratio.
Media
Optional
Supported image types:
  • image/jpeg, JPEG (.jpeg, .jpg)
  • image/gif, GIF (.gif)
  • image/png, PNG (.png)
Supported video types:
  • video/h263, H263 video (.h263)
  • video/m4v, M4V video (.m4v)
  • video/mp4, MP4 video (.mp4)
  • video/mpeg4, MPEG-4 video (.mp4, .m4p)
  • video/mpeg, MPEG video (.mpeg)
  • video/webm, WEBM video (.webm)
Official Documentation:

Note: If the media doesn't fit the dimensions within the card given the selected height, the media preview is chosen by zooming and centrally cropping the media.

Title
Optional
  • Maximum 200 characters
  • Special characters, such as emoji or a multi-byte character set, count as 2–4 characters or more.

Note: The title is optional, but it is recommended to include it for better user experience.

Description
Optional
  • Maximum 2000 characters
  • Special characters, such as emoji or a multi-byte character set, count as 2–4 characters or more.
Suggestions
Optional
  • Maximum 4 suggestions inside of a rich card
  • Maximum 11 suggestions below your rich card in a chip list
  • You can use these 2 formats of suggestions together
Official Documentation

Rich Card Carousel

Media

Air Zoom AlphaFly 3 Flyknit sneakers

Made from breathable Flyknit, they're fitted with an extra set of 'Air Zoom' units

Media

Air Zoom AlphaFly 3 Flyknit sneakers

Fine-tuned for marathon speed, the Alphafly 3 helps push you beyond what you thought possible

Overview

A carousel is a collection of rich cards that are displayed in a horizontal scrollable list. A carousel can have a minimum of 2 cards and a maximum 10 cards.

Properties
  • Card Width
  • Card Contents

Card contents represent each card inside of the carousel.

Card Width

The width of each card in the carousel.

  • SMALL: 120 DP. Note that TALL media cannot be used.
  • MEDIUM: 160 DP. Note that TALL media cannot be used.
  • LARGE: 232 DP
Media
Optional
Supported image types:
  • image/jpeg, JPEG (.jpeg, .jpg)
  • image/gif, GIF (.gif)
  • image/png, PNG (.png)
Supported video types:
  • video/h263, H263 video (.h263)
  • video/m4v, M4V video (.m4v)
  • video/mp4, MP4 video (.mp4)
  • video/mpeg4, MPEG-4 video (.mp4, .m4p)
  • video/mpeg, MPEG video (.mpeg)
  • video/webm, WEBM video (.webm)
Official Documentation:

Note: If the media doesn't fit the dimensions within the card given the selected height, the media preview is chosen by zooming and centrally cropping the media.

Title
Optional
  • Maximum 200 characters
  • Special characters, such as emoji or a multi-byte character set, count as 2–4 characters or more.

Note: The title is optional, but it is recommended to include it for better user experience.

Description
Optional
  • Maximum 2000 characters
  • Special characters, such as emoji or a multi-byte character set, count as 2–4 characters or more.
Suggestions
Optional
  • Maximum 4 suggestions inside of a rich card
  • Maximum 11 suggestions below your rich card in a chip list
  • You can use these 2 formats of suggestions together
Official Documentation

Suggested Replies & Suggested Actions

Overview

Suggested actions help your agent guide users through conversations by leveraging the native functionality of the user's device. Your agent sends suggested actions in suggestion chip lists or in rich cards.

Properties
  • Text
  • Postback data
  • Fallback URL
  • Custom attributes for each type of action
Text
Required

Text that will be displayed in the suggested reply or suggested action.

  • Maximum 25 characters
  • Special characters, such as emoji or a multi-byte character set, count as 2–4 characters or more.
Postback data
Required

Payload (base64 encoded) that will be sent to the agent in the user event that results when the user taps the suggested reply or suggested action.

  • Maximum 2048 characters
Fallback URL
Optional

This URL will open in a new browser window if the user's device doesn't support the suggested action.

  • Maximum 2048 characters
Dial Action
Action

The Dial action guides the user to dial a phone number that your agent specifies.

Fields:
  • Phone number in E.164 format, for example, +12223334444.
Official Documentation:
View Location Action
Action

The View Location action guides the user to view a location on a map that your agent specifies.

Fields:
  • (Optional) Latitude & Longitude
  • (Optional) Label of the pin dropped at LatLong
  • (Optional) Query — only supported by Android. Rather than specify a latLong (and optionally, a label), the agent can instead specify a query string. For default map apps that support search functionality (including Google Maps)
Official Documentation:
Create Calendar Event Action
Action

The Create Calendar Event action guides the user to create a calendar event that your agent specifies.

Fields:
  • Start time
  • End time
  • Title (Maximum 100 characters)
  • Description (Maximum 500 characters)
Official Documentation:
Open URL Action
Action

The Open URL action guides the user to open a URL that your agent specifies.

Fields:
  • URL (Must be a valid URI as defined in RFC 3986. Maximum 2048 characters)
  • Application (BROWSER or WEBVIEW). Default: BROWSER. To check whether a user's device supports webview mode, run a capability check first.
  • Webview view mode (FULL, HALF, TALL)
  • Description
Official Documentation:
Share Location Action
Action

The Share Location action opens the RCS app's location chooser, which prompts the user to share their location with your agent.

Official Documentation:
Compose Action
Action

The Compose action guides the user to compose a message that your agent specifies. To check whether a user's device supports this action, run a capability check first.

Fields:
  • URL (Must be a valid URI as defined in RFC 3986. Maximum 2048 characters)
  • Application (BROWSER or WEBVIEW). Default: BROWSER. To check whether a user's device supports webview mode, run a capability check first.
  • Webview view mode (FULL, HALF, TALL)
  • Description
Official Documentation:
Official Documentation

Media (Self-hosted or File Upload)

Overview

A media is a message that contains a file attachment.

Methods
Self-hosted:
  • File URL (publicly accessible)
File Upload:
  • File Name
  • Thumbnail Name
Suggestions
Optional
  • Maximum 11 suggestions
Official Documentation

Agent Events

Overview

Agent events are events that your agent sends to the user.

Type

IS_TYPING or READ

Official Documentation

Server Events

Overview

The RBM platform sends events to notify your agent about server-level updates such as message expirations.

Type
  • TTL_EXPIRATION_REVOKED (The message has expired and was successfully revoked. This event would be a good trigger for your fallback messaging strategy.)
  • TTL_EXPIRATION_REVOKE_FAILED (The message has expired and was not revoked.)
Official Documentation

User Events

Overview

The RBM platform sends events to notify your agent about user-level updates such as message receipts.

Type
  • DELIVERED (The message has been successfully delivered to the user.)
  • IS_TYPING (The user is typing within a conversation with the agent.)
  • READ (The user has read the message.)
  • UNSUBSCRIBE ( The user doesn't want to receive further non - essential messages sent by the agent.)
  • SUBSCRIBE (The user wants to receive messages from the agent.)
Message

When the user sends a message to your agent, an event without a type is sent. This event contains a "text" field.

Postback

When the user taps on suggested actions or replies, your agent receives an event without a type and with the postback data. In the case of suggested replies, the event contains an additional "text" field.

Official Documentation

Billing

See the table below for Non-conversational agents. For Conversational agents, see Billing Events.

Feature
Description
Type
Text message
A simple text message up to 160 characters without suggestions.
BASIC
Rich Text Message
A simple text message up to 3072 characters or with suggestions.
SINGLE
Rich Card Standalone
A message with media, suggestions, and/or rich card layout.
SINGLE
Rich Card Carousel
Multiple rich cards in a horizontally scrollable layout.
SINGLE
File message
A message containing a file attachment.
SINGLE
Read receipt
Confirmation that a message was read by the agent.
FREE
Delivery receipt
Confirmation that a message was delivered to the agent.
FREE

Use cases: Agent Use Cases and Business Rules