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

Get answer

DME Get answer API

The request to send message to Webhook. You need setting your Webhook in Setting of bot. You send request to FPT.AI then FPT.AI will send result after finish proccess your content via your Webhook.

Example request

curl -X POST \
  https://bot.fpt.ai/api/get_answer/ \
  -H 'Authorization: Bearer <bot_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "channel": "api",
  "app_code": "<bot code>",
  "sender_id": "sender_id_abc",
  "type": "text",
  "message": {
    "content": "<user's question>",
    "type": "text"
  }
}
'

Example response

HTTP 200 OK

Request

POST https://bot.fpt.ai/api/get_answer/

Parameters

ParameterRequiredDescription
channelyesAlways is api
messagesyesMessage content
app_codeyesBot code
sender_idyesID of end user
typeyestext or payload

Text Type

Example request

curl -X POST \
  https://bot.fpt.ai/api/get_answer/ \
  -H 'Authorization: Bearer <bot_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "channel": "api",
  "app_code": "<bot code>",
  "sender_id": "sender_id_abc",
  "type": "text",
  "message": {
    "content": "<user's question>",
    "type": "text"
  }
}
'

Example response

HTTP 200 OK

Parameters

ParameterRequiredDescription
channelyesAlways is api
messagesyesMessage content
app_codeyesBot code
sender_idyesID of end user
typeyestext
contentyesContent send to DME

Payload Type

Example request

curl -X POST \
  https://bot.fpt.ai/api/get_answer/ \
  -H 'Authorization: Bearer <bot_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "channel": "api",
  "app_code": "<bot code>",
  "sender_id": "<sender id>",
  "type": "payload",
  "message": {
    "content": "<Step name>#base64(payload_data)", 
    "type": "payload"
  }
}
'

Example response

HTTP 200 OK

Parameters

ParameterRequiredDescription
channelyesAlways is api
messagesyesMessage content
app_codeyesBot code
sender_idyesID of end user
typeyespayload
contentyesStep code

Response

Returns a JSON message represents the request status.

← DictionaryJSON Card →
  • DME Get answer API
    • Request
    • Text Type
    • Payload Type
    • Response
Conversation
DocumentationAPI ReferenceTutorials (Video)
Reader
DocumentationAPI ReferenceTutorials
Speech
DocumentationAPI ReferenceTutorials
Copyright © 2025 FPT Corporation