Xenioo
  • Welcome!
  • Basic Concepts
    • Your Account
      • The Free plan
      • Upgrading to a paid plan
      • Canceling your subscription
      • Deleting your account
      • Additional Packages
      • Support
      • Payment & Invoicing
      • Messages Count
    • Designing your Chatbot
      • Introduction
      • Behaviors
      • Interactions
      • Actions and Operations
    • Chatbot Details
      • Chatbot Settings
        • General Chatbot Settings
        • Chatbot Conversation Settings
        • Chatbot Integration Settings
      • Teams
        • Team Permissions
        • Team Message Templates
        • Team Member Access
      • Backup & Restore
      • Clone and Reference Clone
    • Publishing
      • Live & Draft Chatbots
      • Publish Your Bot
      • Channels
        • Web
          • Web Variables
          • WordPress
          • Widget Customization
            • Initialization
            • Scripting
        • WhatsApp
          • WhatsApp Variables
          • First Message Processing
          • Configuring Providers
            • Infobip
            • ZOKO
            • MessengerPeople
            • Twilio
            • Chat-API
            • Maytapi
            • Wassenger
            • Waboxapp
        • RCS
          • RCS Variables
          • Configuring Providers
            • LINK Mobility
        • Google Business Messages
          • Google Business Messages Variables
        • SMS
          • SMS Variables
          • Configuring Providers
            • LINK Mobility
        • Facebook
          • Facebook Ads Integration
          • Feed Integration
          • Messenger Referral
          • Facebook Variables
          • Moving users from an existing bot to Xenioo
        • Telegram
          • Telegram Deep Linking
          • Telegram Variables
        • Slack
          • Configuring Slack
          • Slack Variables
        • Microsoft Teams
          • Microsoft Teams Variables
        • Discord
          • Discord Variables
        • Alexa
          • Troubleshooting
          • Alexa Variables
        • Google Assistant
          • Google Assistant Variables
        • Phone
          • Phone Variables
          • Configuring Providers
            • Voximplant
        • Custom
          • REST Reference Guide
          • API Variables
    • Users and Conversation Persistance
  • Artificial Intelligence
    • Intents
    • Expressions
    • Entities
      • Creating Manually
      • Entity Types
      • Synonims
    • Training & Testing your Model
      • Using the NLP Parse Logs
      • Importing Intents From File
    • NLP Master
  • Database
    • Xenioo Database
    • Collections
      • Import And Export Collections Data
    • Database API Interface
      • Url Filtering Syntax
      • Save To Collection
      • Delete From Collection
      • Query Collection
      • CSV Direct Data
  • Broadcasts
    • Broadcasts
      • Settings
        • On Demand
          • HubSpot
        • On Date And Time
        • On Time
        • On Trigger
        • On Interval
    • Campaigns
    • Distribution Lists
    • Audiences
    • Distribution Logs
  • Conversations
    • Conversations
    • Contacts
    • Chat Commands
    • Contact Details
    • Data Retention
  • Actions And Operations
    • Execution
      • Execution Diagram
    • Actions Availability
    • Variables and Tags
    • Dynamic Parsing And Content
    • Content
      • Text Action
      • Random Text Action
      • Quick Reply Action
      • Database Quick Reply Buttons Action
      • Quick Reply Array Action
      • Chat Delay Action
      • Phone Quick Reply Action
      • Email Quick Reply Action
      • Location Quick Reply Action
      • Display Location
      • Image Action
      • Video Action
      • Audio Action
      • File Action
      • Url Action
      • NLP Topics Summary Action
      • Highly Structured Message
      • Custom Class
    • Input
      • Voice Recognition Action
      • Global Detection
        • Text Parse Action
        • NLP Processing Action
        • Dialogflow Detection Action
        • IBM Watson Assistant Intent Detection Action
      • Generic Input Action
      • NLP Input Action
      • Number Input Action
      • Email Input Action
      • Phone Number Action
      • Media Attachment Action
      • Voice Input Action
      • Global Detection Action
      • Dialogflow
        • Dialogflow Input Action
        • Dialogflow Detection Action
      • IBM Watson Assistant
        • IBM Watson Assistant Input Action
        • IBM Watson Assistant Detection Action
    • Flow
      • Go To Action
      • Include Interaction Action
      • Random Split Action
      • Flow Control Action
      • Set Chat Operator State Action
      • Schedule Behaviour Action
      • Variable Switch Action
      • Tag Switch Action
      • Set Context Action
      • Conversation Bookmark Action
      • Create Conversation URL Action
      • Reset Conversation Action
      • Control Conversation Transfer Action
        • Forward Variable Value Action
    • Forms
      • Form Container
      • Fields
        • Text Box
        • Password
        • Text Area
        • Dropdown
        • Checkbox
        • Number
        • Date Picker
        • Time Picker
        • Calendar
        • File Upload
      • Layout
        • Image
        • Literal
        • Divider
        • Html Content
        • Custom CSS
    • Database
      • Load Single Record
      • Delete Records
      • Save Record
      • Save Raw Model
      • Query Collection Data
      • Move To Next Record
      • Set Field Filter Value
      • Order By Field
      • Set Field Value
    • Cards
      • Carousel Template Action
      • List Card Template Action
      • Buttons Card Template Action
      • Card Container Action
      • Interactive Message Action
      • One-Time Notification Request Action
      • Database Carousel Action
      • Dynamic Carousel Action
      • Card And Menu Buttons
        • Postback Button Action
        • URL Button Action
        • Call Phone Button
        • Share Button Action
        • Nested Button Action
        • Interactive Button
    • Profile
      • Set Variable Action
      • Delete Variable Action
      • Set Tag Action
      • Delete Tag Action
      • Set Campaign Subscription Action
    • Privacy
      • Forget User
      • Privacy Opt-In
      • Privacy Flag Condition
    • IoT
      • Control Device State
      • Device State Switch
    • Integration
      • Call API Service Action
      • Execute Cloud Script Action
        • Base Conversation object methods
        • Firebase Connection methods
        • Xenioo Database Collection Methods
      • Execute Client Script Action
      • Send SMS Message
      • Dynamic Content Action
      • Post To Facebook Action
      • Firebase Database Action
      • ActiveCampaign Action
      • Zapier Webhook Action
      • MailChimp Contact Action
      • Wordpress Search Action
      • RSS & Podcast Feed Action
      • SendGrid Mail Action
      • Send Mail Action
      • Send Custom Mail Action
  • Xenioo API
    • Choosing your API
    • Global Platform API
      • Authorization
      • Platform SSO
      • Bots
        • Publish
        • Clone
        • Reference Clone
        • Teams
          • List
          • Add Or Update
          • Delete
      • Conversations
        • Exist
        • Data
        • Share Url
      • AI
      • Statistics
        • Runtime Data
        • Report Files
        • Download Report File
      • Broadcasts
        • Broadcasts List
        • Broadcast State
  • Service State
    • Scheduled Maintenance
    • Platform Changelog
Powered by GitBook
On this page
  • Settings
  • Remarks
  • Trigger
  • Variables
  • Availability

Was this helpful?

  1. Actions And Operations
  2. Cards

Dynamic Carousel Action

PreviousDatabase Carousel ActionNextCard And Menu Buttons

Last updated 5 years ago

Was this helpful?

This action will display a dynamically generated carousel based on standard Xenioo Action Model Json content from either a Url or a variable.

Settings

The action uses the following settings:

Setting

Description

Data Source

Select if the dynamic carousel data model will be downloaded from an Url or retrieved from a variable.

Xenioo Action Model URL

The Url from which the dynamic carousel data will be retrieved.

Xenioo Action Model Variable Source

The variable that holds the dynamic carousel model.

Postback target variable

The variable that will hold any postback command caused by postback buttons inside the dynamic carousel.

Default Image Source

The source of the default card image, if non is supplied inside the model.

Default Element Image

The url of the image to be used as default card image.

Remarks

The following source shows a brief sample of a complete dynamic carousel JSON:

{
  "image_aspect_ratio":"horizontal",
  "items":[
      {
	        title: "Chevrolet Corvette",
	        subtitle: "Buy your Chevrolet Corvette!",
	        image_url:"https://someserver.com/corvette.jpg",
			view_size:"compact",
	        buttons:[
	          {
	              type:'postback',
		          payload: "buy_corvette",
		          text:'Buy Now'
	          },
	          {
	              type:'url',
		          url: "https://www.chevrolet.comr",
		          text:'Visit Website',
			      view_size:'full'
	          }
          ]
      }
  ]
}

The above items collection holds all of the different cards that will be created dynamically. The view_size parameter can have the following values:

Value

Description

compact

The web view will be about half the size of the available mobile screen.

tall

The web view will cover most of the available mobile screen.

full

The webb view will be full screen.

The image_aspect_ratio parameter can have the following values:

Value

Description

horizontal

The image will have a 1:1.91 aspect ratio

square

The image will have a 1:1 aspect ratio.

The type parameter for each button can have the following values:

Value

Description

postback

url

phone

share

If no button type is specified Xenioo will display a postback button.

Trigger

On Postback. This action will trigger any child operation as the user click any postback button.

Variables

This action does not produce any variable.

Availability

Channel specific availability follows the table below:

Channel

Availability

Facebook

Fully Available.

WhatsApp

Not Available.

Telegram

Fully Available.

Web

Fully Available.

Alexa

Device Dependant.

Google Assistant

Device Dependant.

Slack

Fully Available.

API

Fully Available.

The Dynamic Carousel Action will be activated by a very specific JSON model that represents the carousel cards and buttons. The model can be retrieved from an external source or from a .

Aspect ratio parameter is currently supported on on .

Defines a button.

Defines an button.

Defines a button.

Defines a button.

This action can be used only inside interactions and not as child of other actions. Any account can use this action regardless of .

runtime variable
Facebook Messenger channel
subscription level
⛔
✅
✅
✅
⛔
✅
Parsed
postback
Url
Phone
Share