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
  • Feature overview
  • Execute Task
  • Header and Value
  • Input Body
  • Response

Was this helpful?

  1. GETTING STARTED
  2. Testing

Advanced Request

PreviousAutomated TestNextSimulate Dialog

Last updated 5 months ago

Was this helpful?

Feature overview

The Advanced Request allows you to test specific cases in a targeted way, similar to tools like Postman and Insomnia. This function is particularly useful for executing customized requests that require detailed inputs, headers, and responses, supporting efficient troubleshooting of complex scenarios.

To do so, open dialog simulator and then click on the Advanced Request icon (code symbol) in the input box.

Execute Task

The advanced request has some predefined fields to execute the task, but you can add new Header and Value pairs according to your needs. You can add up to 7 Header + Value pairs in total, including those already in place.

Header and Value

Define key headers and their respective values for the request.

If the optional Header + Value pair is not filled, it will be ignored in the execution, even if one of the fields in the pair is filled.

Input Body

A default structure is presented to guide you in. This default is not executable as-is; you must complete it with valid JSON.

The fields to execute an Advanced Request are

  • Text (user input)

  • Code (Answer name, Flow name, Welcome message)

  • Context (variables)

You can add new fields if needed.

The default structure changes based on whether the user execute Welcome Flow or not:

Executing Welcome Flow:

{
  "code": "%EVA_WELCOME_MSG",
  "context": {}
}

NOT executing the Welcome Flow:

{
  "text": "",
  "context": {}
}

When adding a field for Intents, keep in mind that you'll have to also mention the confidence score.

Response

Once the advanced request is processed, the response body will show the output for analysis.

For more information on headers and which ones are mandatory, check the .

For more information on the Request Body check the .

For more information on Response Body, check the .

🚀
Conversation API documentation
Conversation API documentation
Conversation API documentation