Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page
  • Interactive Messaging
  • 1. List Message
  • 2. Quick Reply Button

Was this helpful?

Edit on GitHub
  1. Use
  2. Developer - Contribute to UCI
  3. UCI Basics
  4. Transformers
  5. ODK Transformer

Interactive-Messages

Interactive Messaging

The Interactive Message Templates feature allows you to add buttons in message templates that can be used with List and Quick Replies. Buttons will give the ability to develop interactive experiences with pre-set options for users. There are two types of buttons:

1. List Message

List messages provide a simpler and more consistent format than text-based lists for people to find and select List messages are a way to allow users to easily choose from up to 10 options.

1.1 Steps for creating List Message

For sending a List Message, add following properties in ODK form :

  • type : select_one <field_name> Column type describes the property of any particular message.

  • name : <field_name> Column name refers to unique field_name of any message.

  • label : <text> In label, we can write text content that we want to send to user, If there are any choices available for say select one field, the choices will be appended with this text content.

  • bind::stylingTags : list Bind tag indicates, how a select choice option should be displayed to user as list or buttons. It is also used to define the media type a message.

  • For creating options as list items we have to add the items in the choices tab as we do for the select choices. These are the properties that needs to be set:

    • list name : <field_name> In list name, we write the field name, same as we wrote in the name field of survey tab.

    • name : <indexing> In name field, we write index of a list item.

    • label : <title> In label, we can write the title of a list item, which will be shown to the user.

1.2 Rules for creating List Message

  • In a single List Message maximum 10 list items are allowed.

  • Maximum 24 characters are allowed in list item label.

  • Alphanumeric characters and Spaces are allowed in list item label.

1.3 Example for ODK form of List Message

  • Survey Tab

  • Choices Tab

1.4 Example of List Message Preview

2. Quick Reply Button

These quick reply buttons will help improve the quality of conversations with users by prompting responses that can reduce spelling errors and improve an automated experience. These buttons can be attached to text messages and a maximum of 3 Buttons are allowed in one Message.

2.1 Steps for creating Quick Reply Button

To send Quick Reply Button follow the below steps while creating ODK form :

  • type : select_one <field_name> Column type describes the property of any particular message.

  • name : <field_name> Column name refers to unique field_name of any message.

  • label : <text> In label, we can write text content that we want to send to user, If there are any choices available for say select one field, the choices will be appended with this text content.

  • bind::stylingTags : buttonsForListItems Bind tag indicates, how a select choice option should be displayed to user as list or buttons. It is also used to define the media type a message.

  • For creating buttons for quick reply, we have to add the items in the choices tab as we do for the select choices. These are the properties that needs to be set:

    • list name : <field_name> In list name, we write the field name, same as we wrote in the name field of survey tab.

    • name : <indexing> In name field, we write index of a list item.

    • label : <title> In label, we can write the title of a button, which will be shown to the user.

2.2 Rules for creating Quick Reply Buttons

  • In a single Quick Reply Message, maximum 3 buttons are allowed.

  • Maximum 20 characters are allowed in button label.

  • Alphanumeric characters and Spaces are allowed in button label.

2.3 Example for ODK form of Quick Reply Button

  • Survey Tab

  • Choices Tab

2.4 Example of Quick Reply Button Preview

PreviousODK TransformerNextMedia Messages

Last updated 2 years ago

Was this helpful?

🚀