Wait Input

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

API SUBPATH: eva-wait-input

CRUD Operations

Retrieves detailed information from 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

get

HTTPcURLJavaScriptPython

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"
}

Updates an existing 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

put

HTTPcURLJavaScriptPython

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"
}

Creates a 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

post

HTTPcURLJavaScriptPython

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"
}

Removes an existing 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

delete

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID} HTTP/1.1
Host: 
Accept: */*

No content

Auxiliary Methods

Lists all Wait Input available types. Those must be supplied at their CRUD methods.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

Responses

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/wait-inputs/types HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "name": "text"
  }
]