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/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

waitInputUUID*string

A valid wait input Uuid

Response

200400401403404409422500

Ok

Body

*/*

descriptionstring

Description of the wait input

type*integer (int64)

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstring

Call to action of the wait input

patternstring

Pattern of the wait input

rememberInputboolean

Remember input of the wait input

storedstring

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

idstring

Uuid of the wait input

botIdstring

Bot Uuid of the wait input

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "description": "text",
  "type": 0,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": false,
  "stored": "text",
  "id": "text",
  "botId": "text"
}

Updates an existing Wait Input

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

waitInputUUID*string

A valid wait input Uuid

Body

application/json

descriptionstring

Description of the wait input

type*integer (int64)

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstring

Call to action of the wait input

patternstring

Pattern of the wait input

rememberInputboolean

Remember input of the wait input

storedstring

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

Response

200400401403404409422500

Ok

Body

*/*

descriptionstring

Description of the wait input

type*integer (int64)

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstring

Call to action of the wait input

patternstring

Pattern of the wait input

rememberInputboolean

Remember input of the wait input

storedstring

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

idstring

Uuid of the wait input

botIdstring

Bot Uuid of the wait input

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": 0
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "description": "text",
  "type": 0,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": false,
  "stored": "text",
  "id": "text",
  "botId": "text"
}

Creates a new Wait Inputs

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

descriptionstring

Description of the wait input

type*integer (int64)

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstring

Call to action of the wait input

patternstring

Pattern of the wait input

rememberInputboolean

Remember input of the wait input

storedstring

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

Response

201400401403404409422500

Created

Body

*/*

descriptionstring

Description of the wait input

type*integer (int64)

Type of the wait input. Possible types:

1 - DATE

2 - CUSTOM

3 - EMPTY

4 - HOUR

callToActionstring

Call to action of the wait input

patternstring

Pattern of the wait input

rememberInputboolean

Remember input of the wait input

storedstring

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

idstring

Uuid of the wait input

botIdstring

Bot Uuid of the wait input

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": 0
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "description": "text",
  "type": 0,
  "callToAction": "text",
  "pattern": "text",
  "rememberInput": false,
  "stored": "text",
  "id": "text",
  "botId": "text"
}

Removes an existing Wait Input

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

waitInputUUID*string

A valid wait input Uuid

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/wait-inputs/{waitInputUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Auxiliary Methods

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

GET/org/{orgUUID}/env/{envUUID}/wait-inputs/types

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

Response

200400401403404409422500

Ok

Body

*/*

idinteger (int64)

Id of the wait input type

namestring

Name of the wait input type

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/wait-inputs/types', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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