User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • 🚀GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • 💬BUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • ✨GENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • 🌐CHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • ⚙️CONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • 📊ANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS

Overview

PreviousExternal Analytics PlatformsNextAPI Guidelines

Last updated 8 months ago

Was this helpful?

This section is designed for developers who intend to integrate Syntphony CAI, and infrastructure technicians who intend to install or give maintenance to your Syntphony CAI server system. You may go straight into your required subsection, but we encourage you to fully understand all of the presented subsections below.

Syntphony CAI's platform is based on a microservices architecture and every component has its Rest APIs. A basic understanding of this architecture helps understand the APIs and the content on the next chapters.

The Broker is the orchestrator of the solution. It is responsible for receiving the information needed to execute a conversation. Its API is the one called when a channel receives a message from the user.

Also, it is responsible for calling NLPs dynamically, depending on which NLP was selected by the user in the Cockpit, and for calling external services when these are registered in the Cockpit through the webhook fields.

The main database, which is used by the Broker, is a MySQL database that contains all configuration made through the Cockpit as well as data generated through conversations by the Broker.

Another important component is the Dialog Manager, where you can build and manage the virtual agent conversation flows. This module has its own NoSQL database, for a better performance of the virtual agent. All conversation flows created in the Cockpit are stored in this MongoDB.

The extraction details explained in the following chapters will detail only the MySQL database, since it contains the conversation logs.

If you are here to integrate Syntphony CAI with your custom services and channels, or export/import virtual assistants, you may follow this link:

If rather than an Syntphony CAI cloud service you require an Syntphony CAI server service, the following infrastructure guides will help you to install Syntphony CAI and help you understand it's installation structure in order to give maintenance:

If you are here to understand our database structures or wants to learn where you may extract useful data from, in order to create custom reports, you may follow this link:

API Guidelines
Infrastructure Guidelines
Data Structure