Documentation

Documentation

  • Conversation
  • Reader
  • Speech
  • Console
  • AI Agents
  • Languages iconEnglish
    • Tiếng Việt
    • Janpanese

›Dialogue Management

Documentation

  • Overview
  • I. Chatbot Introduction

    • What is Chatbot
    • Chatbot's purposes
    • Popular types of Chatbot
    • Benefits of using FPT.AI Chatbot
    • Starting with FPT.AI

    II. Building Chatbot on FPT.AI Platform

    • Working Mechanism
    • Bot building process
    • Creating your Chatbot
    • Natural Language Processing - NLP
    • Answer scenarios
    • New Bot scenarios - Bot Builder
    • Answer cards
    • Step connecting buttons
    • Getting customer's information using Form cards
    • Variable settings and management
    • Variable condition review
    • Memories
    • Send/get information via JSON API card
    • Reminder
    • Advanced functions
    • Persistent menu

    III. History

    • History - Updating Bot knowledge

    IV. Multi-channel Integration

    • Integrate with Facebook
    • Integrate with Facebook at Work
    • Integrate with Viber
    • Integrate with Zalo
    • Integrate with website
    • Webhook

    V. Broadcast

    • Broadcast

    VI. Auto Comment

    • Auto comment on Facebook

    VII. Automation Test

    • Check base on testcases
    • Auto create testcases

    VIII. Analytics

    • Introduction
    • Number of user's requests
    • Top matched intents
    • Chat with Bot
    • Number of new users
    • Top scenarios
    • Number of messages bot answered
    • Number of user's requests per hour
    • Number of active users per hour
    • Real-time analytics
    • Broadcast report

    X. Rating and Survey

    • Rating
    • Survey

    XI. Bot Setting - Management

    • Introduction
    • Bot information
    • Messages management
    • Data management
    • Bot intent confidence
    • Delete Bot data
    • Delete bot
    • Transfer bot ownership
    • Version

    XII. Bot Roles

    • Bot roles

    XIII. Chatbot SDK

    • Chat Bot SDK
  • Appendices

Live Support

  • Introduction
  • Customer list interface
  • Customer support flow
  • Note feature
  • Suppoter chat
  • KPI report feature
  • Ticket config
  • Ticket report
  • Archive conversation
  • Ticket management
  • Auto assign to supporters

Tutorials (Videos)

  • 1. Brief overview of FPT.AI
  • 2. Using QnA feature to create a Chatbot
  • 3. Creating Chatbot with complicated scenarios
  • 4. Precondition fucntion in Scenarios
  • 5. Random answer function in Scenarios
  • 6. NLP feature
  • 7. Exact match and Predictive Match in NLP
  • 8. History of Recognition
  • 9. Broadcast feature
  • 10. Live Support feature
  • 11. Persistent Menu
  • 12. Auto-comment feature on Facebook
  • 13. Bot roles
  • 14. Bot configuration in Settings section
  • 15. Integration Chatbot with Facebook
  • 16. Integration Chatbot with Facebook at Work

API Reference

  • Introduction
  • General
  • Natural Language Processing

    • Intent
    • Entity
    • Sample
    • Train
    • Predict
    • Keyword
    • Dictionary

    Dialogue Management

    • Get Answer
    • JSON Card
    • Types of the message

API Reference

Types of the message

DME have some types of the message include: Text, Image, Carousel, Form, Quick reply card

Text message

The message send to user.

Formart of message is:

{
  "channel": "api",
  "app_code": "<bot code>",
  "messages": [
    {
      "type": "text",
      "content": {
        "text": "Content of message",
        "buttons": [
          {
            "title": "B1",
            "payload": "<Step name>#base64(payload_data)"
          },
          {
            "title": "B2",
            "url": "https://fpt.ai"
          },
          {
            "title": "B3",
            "phone_number": "+84999999999"
          }
        ]
      }
    }
  ],
  "sender_id": "sender_id_abc"
}

Description

PropertyRequiredDescription
channelyesChannel of message
app_codeyesBot code
sender_idyesID of end user
typeyesType of message in this case is 'text'
content.textyesContent of message
content.buttonsNoButtons array of message. It can is empty
content.buttons.titleyesText label for button
content.buttons.payloadnoStep code will jump to
content.buttons.urlnoURL will open
content.buttons.phone_numbernoPhone number will call

Image message

The message is images send to user.

Formart of message is:

{
  "channel": "api",
  "app_code": "<bot code>",
  "messages": [
    {
      "type": "image",
      "content": {
        "title": "<title>",
        "url": "https://cdn-static-v3.fpt.ai/upload/cca157c89f060dbaa6250da371ca363b/46954f056fcd28e60be401d9354fd68c.png"
      }
    }
  ],
  "sender_id": "sender_id_abc"
}

Description

PropertyRequiredDescription
channelyesChannel of message
app_codeyesBot code
sender_idyesID of end user
typeyesType of message (in this type is 'image')
content.titleyesTitle of image
content.urlyesURL of image

Carousel message

The message is carousel send to user.

Formart of message is:

{
  "channel": "api",
  "app_code": "<bot code>",
  "messages": [
    {
      "type": "carousel",
      "content": {
        "carousel_cards": [
          {
            "image_url": "<image url>",
            "subtitle": "B1 Desc",
            "title": "New Carousel",
            "buttons": [
              {
                "title": "B1",
                "payload": "<Step name>#base64(payload_data)"
              }
            ],
            "item_url": ""
          },
          {
            "image_url": "<image url>",
            "subtitle": "B2 Desc",
            "title": "New carousel",
            "buttons": [
              {
                "title": "B2",
                "payload": "<Step name>#base64(payload_data)"
              }
            ],
            "item_url": ""
          }
        ]
      }
    }
  ],
  "sender_id": "sender_id_abc"
}

Description

PropertyRequiredDescription
channelyesChannel of message
app_codeyesBot code
sender_idyesID of end user
typeyesType of message (in this type is 'carousel')
content.carousel_cardsyesThe array of Carousel cards.
content.carousel_cards.titleyesTitle of card
content.carousel_cards.subtitleyesDescription of card
content.carousel_cards.buttonnoThe array of buttons
content.carousel_cards.item_urlnoThe link will open if click on item of carousel

Form message

The message send to user.

Formart of message is:

{
  "channel": "api",
  "app_code": "<bot code>",
  "messages": [
    {
      "type": "text",
      "content": {
        "text": "<content>"
      }
    }
  ],
  "sender_id": "sender_id_abc"
}

Description

PropertyRequiredDescription
channelyesChannel of message
app_codeyesBot code
sender_idyesID of end user
typeyesType of message in this case is 'text'
content.textyesContent of message

Quick Reply Card message

The message send to user.

Formart of message is:

{
  "channel": "api",
  "app_code": "<bot code>",
  "messages": [
    {
      "type": "quick_reply",
      "content": {
        "text": "Content of message",
        "buttons": [
          {
            "title": "B1",
            "payload": "<Step name>#base64(payload_data)"
          },
          {
            "title": "B2",
            "url": "https://bot.fpt.ai"
          },
          {
            "title": "B3",
            "phone_number": "+84999999999"
          }
        ]
      }
    }
  ],
  "sender_id": "sender_id_abc"
}

Description

PropertyRequiredDescription
channelyesChannel of message
app_codeyesBot code
sender_idyesID of end user
typeyesType of message in this case is 'quick_reply'
content.textyesContent of message
content.buttonsNoButtons array of message. It can is empty
content.buttons.titleyesText label for button
content.buttons.payloadnoStep code will jump to
content.buttons.urlnoURL will open
content.buttons.phone_numbernoPhone number will call

Payload data

{
  "set_attributes": {
    "<variable name 1>": "<value>",
    "<variable name 2>": "<value>"
  }
 }
← JSON Card
  • Text message
  • Image message
  • Carousel message
  • Form message
  • Quick Reply Card message
    • Payload data
Conversation
DocumentationAPI ReferenceTutorials (Video)
Reader
DocumentationAPI ReferenceTutorials
Speech
DocumentationAPI ReferenceTutorials
Copyright © 2025 FPT Corporation