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
  2. API Guidelines
  3. Management API
  4. Instance API

Wait Input

The Wait input API handles your Wait input Cells found in your flows.

PreviousRest ConnectorNextWebsnippet

Last updated 5 months ago

Was this helpful?

API SUBPATH: eva-wait-input

CRUD Operations

Auxiliary Methods

Find a wait input

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

waitInputUUIDstringRequired

A valid wait input Uuid

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID} HTTP/1.1
Host: 
Accept: */*
{
  "description": "text",
  "type": 1,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": true,
  "stored": "text",
  "id": "text",
  "botId": "text"
}

Removes wait input

delete
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

waitInputUUIDstringRequired

A valid wait input Uuid

Responses
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID} HTTP/1.1
Host: 
Accept: */*

No content

List wait input types

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/wait-inputs/types HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": 1,
    "name": "text"
  }
]
  • CRUD Operations
  • POSTCreate new wait inputs
  • GETFind a wait input
  • PUTUpdate wait input
  • DELETERemoves wait input
  • Auxiliary Methods
  • GETList wait input types

Create new wait inputs

post
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

A body containing all necessary data to create a new wait input

descriptionstringOptional

Description of the wait input

typeinteger · int64Required

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstringOptional

Call to action of the wait input

patternstringOptional

Pattern of the wait input

rememberInputbooleanOptional

Remember input of the wait input

storedstringOptional

Name of variable to store when wait input is used if it's to remember

Responses
201
Created
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "description": "text",
  "type": 1,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": true,
  "stored": "text"
}
{
  "description": "text",
  "type": 1,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": true,
  "stored": "text",
  "id": "text",
  "botId": "text"
}

Update wait input

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

waitInputUUIDstringRequired

A valid wait input Uuid

Body

A body containing all necessary data to create a new wait input

descriptionstringOptional

Description of the wait input

typeinteger · int64Required

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstringOptional

Call to action of the wait input

patternstringOptional

Pattern of the wait input

rememberInputbooleanOptional

Remember input of the wait input

storedstringOptional

Name of variable to store when wait input is used if it's to remember

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "description": "text",
  "type": 1,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": true,
  "stored": "text"
}
{
  "description": "text",
  "type": 1,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": true,
  "stored": "text",
  "id": "text",
  "botId": "text"
}