API DOCSVOICE GATEWAYSECURITY

Dialog Manager

The Dialog Manager is where you configure and draw your flows; Those are the methods you'll need to setup a user flow, configure each Cell and link them.

API SUBPATH: eva-dialog-manager

Flows

Pagination and Listings

Its function is to provide a list of Flow in page format

get
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

Query parameters
enabledbooleanRequired

It is the status of the flow, represents whether it is active, default value true

Example: true
pageinteger · int32Required

It is the number of pages that will be returned, default value 0

Default: 0Example: 1
linesPerPageinteger · int32Required

It is the number of Flow per page, default value 5

Default: 5Example: 1
orderBystringRequired

It is the flow attribute used for the page, default attribute name

Default: name
directionstringRequired

It is the sorting type, default value ASC

Default: ASC
searchTermsstring[]Required

It is the parameter that contains the user data entry, that will be used to filter the flows

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows?enabled=true&page=0&linesPerPage=5&orderBy=name&direction=ASC&searchTerms=text HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "type": "USER_JOURNEY",
      "size": 1,
      "lastModified": {
        "uuid": "text",
        "image": "text",
        "name": "text",
        "timeStamp": 1
      },
      "rules": {
        "delete": true,
        "jumped": true,
        "children": [
          "text"
        ]
      },
      "tags": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Searches (greedily) for any flow names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.

get
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

Query parameters
namestringRequired

It is the parameter used to search for flows related to the entered value

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200

Ok

*/*
Responsestring[]
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/quicksearch?name=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

CRUD Operations

Service responsible for creating a flow.

post
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

The object that contains the data needed to create a Flow

namestringOptional

Name of the flow.

descriptionstringOptional

Description of the flow.

typestring · enumOptional

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

Possible values:
Responses
201

CREATED

*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "type": "USER_JOURNEY"
}
{
  "uuid": "text",
  "name": "text",
  "type": "USER_JOURNEY",
  "size": 1,
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "tags": [
    {
      "name": "text"
    }
  ]
}

Acquires complete, detailed information of a Flow

get
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

uuidstringRequired

It is the uuid used to search for a Flow

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid} HTTP/1.1
Host: 
Accept: */*

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "type": "USER_JOURNEY",
  "uuid": "text",
  "createdBy": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "disconnected": true,
  "editors": [
    {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timeStamp": 1
    }
  ],
  "cellsType": [
    {
      "size": 1,
      "cellType": "text",
      "names": [
        "text"
      ]
    }
  ],
  "jumpFrom": {}
}

Service responsible for updating a flow

put
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

uuidstringRequired

It is the uuid used to search for the Flow that will be updated

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

The object that contains the data needed to create a Flow

namestringOptional

Name of the flow.

descriptionstringOptional

Description of the flow.

typestring · enumOptional

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

Possible values:
Responses
200

OK

*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "type": "USER_JOURNEY"
}
{
  "uuid": "text",
  "name": "text",
  "type": "USER_JOURNEY",
  "size": 1,
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "tags": [
    {
      "name": "text"
    }
  ]
}

Removes an existing flow.

delete
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

uuidstringRequired

It is the uuid used to search for the Flow that will be deleted

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
204

NO_CONTENT

No content
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid} HTTP/1.1
Host: 
Accept: */*

No content

Auxiliary Methods

Analyzes which types of Flows have already been created, and returns a list of possible types that can still be created

get
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/types-to-create HTTP/1.1
Host: 
Accept: */*

[
  "USER_JOURNEY"
]

Endpoint to list the flow names of one bot that have cells with the type passed as parameter

get
Path parameters
orgUUIDstringRequired

It is the organization uuid where the bot is

envUUIDstringRequired

It is the environment uuid where the bot is

botUUIDstringRequired

It is the identification of the bot

Query parameters
userUUIDstringOptional

It is the user uuid is making the request

cellTypestring · enumRequired

It is the cell type to find the flow with. Possible values: ANSWER, ANYTHING_ELSE, INTENT,ENTITY, SYSTEM_ENTITY, SERVICE, GENERATIVE_SERVICE, REST, WELCOME_MESSAGE, USER, BOT, JUMP, WAIT_INPUT, RULE, CODE, PLACE_HOLDER, END and START

Possible values:
Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200

Ok

*/*
Responsestring[]
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/by-cellType?cellType=ANSWER HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Flow Tree

Its function is to find the Flow data, containing the complete tree, rules and so on

get
Path parameters
orgUUIDstringRequired

It is the organization where the flow is, used to connect to the correct database

envUUIDstringRequired

It is the environment where the flow is, used to connect to the correct database

botUUIDstringRequired

It is the bot where the flow is, used to filter Flows

uuidstringRequired

It is the uuid used to search for a Flow

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}/tree HTTP/1.1
Host: 
Accept: */*

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "type": "USER_JOURNEY",
  "uuid": "text",
  "createdBy": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 1
  },
  "rules": {
    "delete": true,
    "jumped": true,
    "children": [
      "text"
    ]
  },
  "disconnected": true,
  "editors": [
    {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timeStamp": 1
    }
  ],
  "cellsType": [
    {
      "size": 1,
      "cellType": "text",
      "names": [
        "text"
      ]
    }
  ],
  "jumpFrom": {},
  "tree": {
    "uuid": "text",
    "cellFirst": true,
    "cellParentUUID": "text",
    "buttonParentUUID": "text",
    "flowUUID": "text",
    "draftText": "text",
    "cellName": "text",
    "cellType": "text",
    "modelVersion": "text",
    "cellEnable": true,
    "expressionCode": "text",
    "objectRef": "text",
    "editor": {
      "uuid": "text",
      "lastModified": true,
      "lastEdition": 1
    },
    "jumpTo": {
      "cellDestination": "text",
      "cellDestinationName": "text",
      "flowDestination": "text",
      "flowDestinationName": "text"
    },
    "rules": {
      "connectionOnTheLeft": true,
      "connectionOnTheRight": true,
      "connectionOnTheBottom": true,
      "delete": true,
      "children": [
        "text"
      ],
      "sequence": [
        "text"
      ],
      "jump": [
        "text"
      ]
    },
    "disconnected": true,
    "executionLimit": 1,
    "hasSibling": true,
    "jumpFrom": [
      {
        "cellOrigin": "text",
        "flowOrigin": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 1
      }
    ],
    "children": [
      {
        "uuid": "text",
        "cellFirst": true,
        "cellParentUUID": "text",
        "buttonParentUUID": "text",
        "flowUUID": "text",
        "draftText": "text",
        "cellName": "text",
        "cellType": "text",
        "modelVersion": "text",
        "cellEnable": true,
        "expressionCode": "text",
        "objectRef": "text",
        "editor": {
          "uuid": "text",
          "lastModified": true,
          "lastEdition": 1
        },
        "jumpTo": {
          "cellDestination": "text",
          "cellDestinationName": "text",
          "flowDestination": "text",
          "flowDestinationName": "text"
        },
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "delete": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ],
          "jump": [
            "text"
          ]
        },
        "disconnected": true,
        "executionLimit": 1,
        "hasSibling": true,
        "jumpFrom": [
          {
            "cellOrigin": "text",
            "flowOrigin": "text"
          }
        ],
        "tags": [
          {
            "name": "text",
            "objectRef": "text",
            "tagTypeId": 1
          }
        ],
        "children": [
          {
            "uuid": "text",
            "cellFirst": true,
            "cellParentUUID": "text",
            "buttonParentUUID": "text",
            "flowUUID": "text",
            "draftText": "text",
            "cellName": "text",
            "cellType": "text",
            "modelVersion": "text",
            "cellEnable": true,
            "expressionCode": "text",
            "objectRef": "text",
            "editor": {
              "uuid": "text",
              "lastModified": true,
              "lastEdition": 1
            },
            "jumpTo": {
              "cellDestination": "text",
              "cellDestinationName": "text",
              "flowDestination": "text",
              "flowDestinationName": "text"
            },
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "delete": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ],
              "jump": [
                "text"
              ]
            },
            "disconnected": true,
            "executionLimit": 1,
            "hasSibling": true,
            "jumpFrom": [
              {
                "cellOrigin": "text",
                "flowOrigin": "text"
              }
            ],
            "tags": [
              {
                "name": "text",
                "objectRef": "text",
                "tagTypeId": 1
              }
            ],
            "children": "[Circular Reference]",
            "options": [
              {
                "buttonUUID": "text",
                "cockpitUUID": "text",
                "urlRedirect": true,
                "buttonUrl": "text",
                "buttonType": "text",
                "buttonText": "text",
                "expressionCode": "text",
                "connectedTo": "text",
                "disconnected": true,
                "rules": {
                  "connectionOnTheLeft": true,
                  "connectionOnTheRight": true,
                  "connectionOnTheBottom": true,
                  "children": [
                    "text"
                  ],
                  "sequence": [
                    "text"
                  ]
                }
              }
            ],
            "description": "text",
            "template": "text",
            "persona": {
              "persona": "text",
              "iconUrl": "text"
            }
          }
        ],
        "options": [
          {
            "buttonUUID": "text",
            "cockpitUUID": "text",
            "urlRedirect": true,
            "buttonUrl": "text",
            "buttonType": "text",
            "buttonText": "text",
            "expressionCode": "text",
            "connectedTo": "text",
            "disconnected": true,
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ]
            }
          }
        ],
        "description": "text",
        "template": "text",
        "persona": {
          "persona": "text",
          "iconUrl": "text"
        }
      }
    ],
    "options": [
      {
        "buttonUUID": "text",
        "cockpitUUID": "text",
        "urlRedirect": true,
        "buttonUrl": "text",
        "buttonType": "text",
        "buttonText": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "disconnected": true,
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ]
        }
      }
    ],
    "description": "text",
    "template": "text",
    "persona": {
      "persona": "text",
      "iconUrl": "text"
    }
  }
}

Cells

CRUD Operations

Create new cells

post
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
flowUUIDstringRequired

Uuid flow to insert the new cell

cellParentUUIDstringOptional

Uuid of the parent cell. Necessary if it is not the first cell of flow

buttonUUIDstringOptional

Uuid of the button. Necessary if it's a service cell parent

Default: ""
actionstring · enumOptional

Type of insertion

Default: CHILDRENPossible values:
Body

A body containing all necessary data to create a new cell

cellNamestringRequired

Name of the cell

cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
descriptionstringOptional

Description of the cell

objectRefstringOptional

Uuid of object to relationate. It can be intent, entity, service...

expressionCodestringRequired

Expression code of the cell

templatestringOptional

Template of the cell. It's required if cell is code or rule type

executionLimitinteger · int64Optional

Number of times that the cell has to execute repeatedly

iconstringOptional

Icon associated with the cell

personastringOptional

Persona associated with the cell

Responses
201

Created

*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells?flowUUID=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 403

{
  "cellName": "text",
  "cellType": "ANSWER",
  "description": "text",
  "objectRef": "text",
  "expressionCode": "text",
  "jumpTo": {
    "cellDestination": "text",
    "flowDestination": "text"
  },
  "template": "text",
  "executionLimit": 1,
  "options": [
    {
      "cockpitUUID": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "buttonType": "text",
      "buttonText": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "icon": "text",
  "persona": "text"
}
[
  {
    "uuid": "text",
    "cellFirst": true,
    "cellParentUUID": "text",
    "buttonParentUUID": "text",
    "flowUUID": "text",
    "draftText": "text",
    "cellName": "text",
    "cellType": "text",
    "modelVersion": "text",
    "cellEnable": true,
    "expressionCode": "text",
    "objectRef": "text",
    "editor": {
      "uuid": "text",
      "lastModified": true,
      "lastEdition": 1
    },
    "jumpTo": {
      "cellDestination": "text",
      "cellDestinationName": "text",
      "flowDestination": "text",
      "flowDestinationName": "text"
    },
    "rules": {
      "connectionOnTheLeft": true,
      "connectionOnTheRight": true,
      "connectionOnTheBottom": true,
      "delete": true,
      "children": [
        "text"
      ],
      "sequence": [
        "text"
      ],
      "jump": [
        "text"
      ]
    },
    "disconnected": true,
    "executionLimit": 1,
    "hasSibling": true,
    "jumpFrom": [
      {
        "cellOrigin": "text",
        "flowOrigin": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 1
      }
    ],
    "children": [
      {
        "uuid": "text",
        "cellFirst": true,
        "cellParentUUID": "text",
        "buttonParentUUID": "text",
        "flowUUID": "text",
        "draftText": "text",
        "cellName": "text",
        "cellType": "text",
        "modelVersion": "text",
        "cellEnable": true,
        "expressionCode": "text",
        "objectRef": "text",
        "editor": {
          "uuid": "text",
          "lastModified": true,
          "lastEdition": 1
        },
        "jumpTo": {
          "cellDestination": "text",
          "cellDestinationName": "text",
          "flowDestination": "text",
          "flowDestinationName": "text"
        },
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "delete": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ],
          "jump": [
            "text"
          ]
        },
        "disconnected": true,
        "executionLimit": 1,
        "hasSibling": true,
        "jumpFrom": [
          {
            "cellOrigin": "text",
            "flowOrigin": "text"
          }
        ],
        "tags": [
          {
            "name": "text",
            "objectRef": "text",
            "tagTypeId": 1
          }
        ],
        "children": [
          {
            "uuid": "text",
            "cellFirst": true,
            "cellParentUUID": "text",
            "buttonParentUUID": "text",
            "flowUUID": "text",
            "draftText": "text",
            "cellName": "text",
            "cellType": "text",
            "modelVersion": "text",
            "cellEnable": true,
            "expressionCode": "text",
            "objectRef": "text",
            "editor": {
              "uuid": "text",
              "lastModified": true,
              "lastEdition": 1
            },
            "jumpTo": {
              "cellDestination": "text",
              "cellDestinationName": "text",
              "flowDestination": "text",
              "flowDestinationName": "text"
            },
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "delete": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ],
              "jump": [
                "text"
              ]
            },
            "disconnected": true,
            "executionLimit": 1,
            "hasSibling": true,
            "jumpFrom": [
              {
                "cellOrigin": "text",
                "flowOrigin": "text"
              }
            ],
            "tags": [
              {
                "name": "text",
                "objectRef": "text",
                "tagTypeId": 1
              }
            ],
            "children": "[Circular Reference]",
            "options": [
              {
                "buttonUUID": "text",
                "cockpitUUID": "text",
                "urlRedirect": true,
                "buttonUrl": "text",
                "buttonType": "text",
                "buttonText": "text",
                "expressionCode": "text",
                "connectedTo": "text",
                "disconnected": true,
                "rules": {
                  "connectionOnTheLeft": true,
                  "connectionOnTheRight": true,
                  "connectionOnTheBottom": true,
                  "children": [
                    "text"
                  ],
                  "sequence": [
                    "text"
                  ]
                }
              }
            ],
            "description": "text",
            "template": "text",
            "persona": {
              "persona": "text",
              "iconUrl": "text"
            }
          }
        ],
        "options": [
          {
            "buttonUUID": "text",
            "cockpitUUID": "text",
            "urlRedirect": true,
            "buttonUrl": "text",
            "buttonType": "text",
            "buttonText": "text",
            "expressionCode": "text",
            "connectedTo": "text",
            "disconnected": true,
            "rules": {
              "connectionOnTheLeft": true,
              "connectionOnTheRight": true,
              "connectionOnTheBottom": true,
              "children": [
                "text"
              ],
              "sequence": [
                "text"
              ]
            }
          }
        ],
        "description": "text",
        "template": "text",
        "persona": {
          "persona": "text",
          "iconUrl": "text"
        }
      }
    ],
    "options": [
      {
        "buttonUUID": "text",
        "cockpitUUID": "text",
        "urlRedirect": true,
        "buttonUrl": "text",
        "buttonType": "text",
        "buttonText": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "disconnected": true,
        "rules": {
          "connectionOnTheLeft": true,
          "connectionOnTheRight": true,
          "connectionOnTheBottom": true,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ]
        }
      }
    ],
    "description": "text",
    "template": "text",
    "persona": {
      "persona": "text",
      "iconUrl": "text"
    }
  }
]

Retrieves detailed information of a Cell.

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

cellUUIDstringRequired

A valid cell Uuid

Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "text",
  "cellFirst": true,
  "cellParentUUID": "text",
  "buttonParentUUID": "text",
  "flowUUID": "text",
  "draftText": "text",
  "cellName": "text",
  "cellType": "text",
  "modelVersion": "text",
  "cellEnable": true,
  "expressionCode": "text",
  "objectRef": "text",
  "editor": {
    "uuid": "text",
    "lastModified": true,
    "lastEdition": 1
  },
  "jumpTo": {
    "cellDestination": "text",
    "cellDestinationName": "text",
    "flowDestination": "text",
    "flowDestinationName": "text"
  },
  "rules": {
    "connectionOnTheLeft": true,
    "connectionOnTheRight": true,
    "connectionOnTheBottom": true,
    "delete": true,
    "children": [
      "text"
    ],
    "sequence": [
      "text"
    ],
    "jump": [
      "text"
    ]
  },
  "disconnected": true,
  "executionLimit": 1,
  "hasSibling": true,
  "jumpFrom": [
    {
      "cellOrigin": "text",
      "flowOrigin": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "children": [
    {
      "uuid": "text",
      "cellFirst": true,
      "cellParentUUID": "text",
      "buttonParentUUID": "text",
      "flowUUID": "text",
      "draftText": "text",
      "cellName": "text",
      "cellType": "text",
      "modelVersion": "text",
      "cellEnable": true,
      "expressionCode": "text",
      "objectRef": "text",
      "editor": {
        "uuid": "text",
        "lastModified": true,
        "lastEdition": 1
      },
      "jumpTo": {
        "cellDestination": "text",
        "cellDestinationName": "text",
        "flowDestination": "text",
        "flowDestinationName": "text"
      },
      "rules": {
        "connectionOnTheLeft": true,
        "connectionOnTheRight": true,
        "connectionOnTheBottom": true,
        "delete": true,
        "children": [
          "text"
        ],
        "sequence": [
          "text"
        ],
        "jump": [
          "text"
        ]
      },
      "disconnected": true,
      "executionLimit": 1,
      "hasSibling": true,
      "jumpFrom": [
        {
          "cellOrigin": "text",
          "flowOrigin": "text"
        }
      ],
      "tags": [
        {
          "name": "text",
          "objectRef": "text",
          "tagTypeId": 1
        }
      ],
      "children": [
        {
          "uuid": "text",
          "cellFirst": true,
          "cellParentUUID": "text",
          "buttonParentUUID": "text",
          "flowUUID": "text",
          "draftText": "text",
          "cellName": "text",
          "cellType": "text",
          "modelVersion": "text",
          "cellEnable": true,
          "expressionCode": "text",
          "objectRef": "text",
          "editor": {
            "uuid": "text",
            "lastModified": true,
            "lastEdition": 1
          },
          "jumpTo": {
            "cellDestination": "text",
            "cellDestinationName": "text",
            "flowDestination": "text",
            "flowDestinationName": "text"
          },
          "rules": {
            "connectionOnTheLeft": true,
            "connectionOnTheRight": true,
            "connectionOnTheBottom": true,
            "delete": true,
            "children": [
              "text"
            ],
            "sequence": [
              "text"
            ],
            "jump": [
              "text"
            ]
          },
          "disconnected": true,
          "executionLimit": 1,
          "hasSibling": true,
          "jumpFrom": [
            {
              "cellOrigin": "text",
              "flowOrigin": "text"
            }
          ],
          "tags": [
            {
              "name": "text",
              "objectRef": "text",
              "tagTypeId": 1
            }
          ],
          "children": [
            "[Circular Reference]"
          ],
          "options": [
            {
              "buttonUUID": "text",
              "cockpitUUID": "text",
              "urlRedirect": true,
              "buttonUrl": "text",
              "buttonType": "text",
              "buttonText": "text",
              "expressionCode": "text",
              "connectedTo": "text",
              "disconnected": true,
              "rules": {
                "connectionOnTheLeft": true,
                "connectionOnTheRight": true,
                "connectionOnTheBottom": true,
                "children": [
                  "text"
                ],
                "sequence": [
                  "text"
                ]
              }
            }
          ],
          "description": "text",
          "template": "text",
          "persona": {
            "persona": "text",
            "iconUrl": "text"
          }
        }
      ],
      "options": [
        {
          "buttonUUID": "text",
          "cockpitUUID": "text",
          "urlRedirect": true,
          "buttonUrl": "text",
          "buttonType": "text",
          "buttonText": "text",
          "expressionCode": "text",
          "connectedTo": "text",
          "disconnected": true,
          "rules": {
            "connectionOnTheLeft": true,
            "connectionOnTheRight": true,
            "connectionOnTheBottom": true,
            "children": [
              "text"
            ],
            "sequence": [
              "text"
            ]
          }
        }
      ],
      "description": "text",
      "template": "text",
      "persona": {
        "persona": "text",
        "iconUrl": "text"
      }
    }
  ],
  "options": [
    {
      "buttonUUID": "text",
      "cockpitUUID": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "buttonType": "text",
      "buttonText": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "disconnected": true,
      "rules": {
        "connectionOnTheLeft": true,
        "connectionOnTheRight": true,
        "connectionOnTheBottom": true,
        "children": [
          "text"
        ],
        "sequence": [
          "text"
        ]
      }
    }
  ],
  "description": "text",
  "template": "text",
  "persona": {
    "persona": "text",
    "iconUrl": "text"
  }
}

Updates an existing Cell.

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

cellUUIDstringRequired

A valid cell Uuid

Body

A body containing all necessary data to update cell

cellNamestringRequired

Name of the cell

descriptionstringOptional

Description of the cell

objectRefstringOptional

Uuid of object to relationate. It can be intent, entity, service...

expressionCodestringRequired

Expression code of the cell

cellEnablebooleanRequired

True if wants to enable cell or false if not

templatestringOptional

Template of the cell. It's required if cell is code or rule type

executionLimitinteger · int64Optional

Number of times that the cell has to execute repeatedly

iconstringOptional

Icon of the cell

personastringOptional

Persona of the cell

Responses
204

No Content

No content
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "cellName": "text",
  "description": "text",
  "objectRef": "text",
  "expressionCode": "text",
  "cellEnable": true,
  "jumpTo": {
    "cellDestination": "text",
    "flowDestination": "text"
  },
  "template": "text",
  "executionLimit": 1,
  "options": [
    {
      "cockpitUUID": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "buttonType": "text",
      "buttonText": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "icon": "text",
  "persona": "text"
}
No content

Removes an existing Cell.

delete
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

cellUUIDstringRequired

A valid cell Uuid

Query parameters
deleteInCascadebooleanOptional

True if wants to delete all children of the cell. False if wants to delete only the cell and converting it to Placeholder type

Default: true
Responses
204

No Content

No content
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID} HTTP/1.1
Host: 
Accept: */*

No content

Auxiliary Methods

Valid the template of cell

post
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
Body

DTO with the template of cell to valid

templatestringOptional
Responses
200

Ok

*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/template/validate?cellType=ANSWER HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "template": "text"
}
{
  "valid": true,
  "message": "text"
}

List all cells of a bot by the type passed in parameter

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type?cellType=ANSWER HTTP/1.1
Host: 
Accept: */*

[
  {
    "objectRef": "text",
    "cellType": "text"
  }
]

List all objectRef of cells that are the first cell of any flow in one bot

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
Responses
200

Ok

*/*
Responsestring[]
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/start-flows?cellType=ANSWER HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

List all buttons of service cell

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
objectRefstringRequired

Id of the object intent, entity, service...

Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/buttons?cellType=ANSWER&objectRef=text HTTP/1.1
Host: 
Accept: */*

[
  {
    "buttonUUID": "text",
    "cockpitUUID": "text",
    "urlRedirect": true,
    "buttonUrl": "text",
    "buttonType": "text",
    "buttonText": "text",
    "expressionCode": "text",
    "connectedTo": "text"
  }
]

List all cells informing if can be connected left, bottom or right

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
uuidstringRequired

A valid cell Uuid

directionstring · enumRequired

Direction that wants to know the possible connections. It can be left, bottom or right

Possible values:
Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?uuid=text&direction=LEFT HTTP/1.1
Host: 
Accept: */*

[
  {
    "uuid": "text",
    "connectionOnTheLeft": true,
    "connectionOnTheRight": true,
    "connectionOnTheBottom": true
  }
]

List all flows that is possible to jump

get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
flowUUIDstringRequired

A valid flow Uuid

cellParentUUIDstringRequired

Uuid of the parent cell

actionstring · enumOptional

Type of insertion

Default: CHILDRENPossible values:
cellTypestring · enumOptional

Enumeration of cell types.

Default: JUMPPossible values:
Responses
200

Ok

*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/jump?flowUUID=text&cellParentUUID=text HTTP/1.1
Host: 
Accept: */*

[
  {
    "uuid": "text",
    "name": "text",
    "type": "USER_JOURNEY",
    "enabled": true,
    "error": "text"
  }
]

Massive update

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
objectRefstringRequired

Id of the object (intent, entity, service...

Body

A body containing all necessary data to update cells

cellNamestringRequired

Name of the cell

descriptionstringOptional

Description of the cell

expressionCodestringRequired

Expression code of the cell

cellEnablebooleanRequired

True if wants to enable cell or false if not

executionLimitinteger · int64Optional

Number of times that the cell has to execute repeatedly

templatestringOptional

Template of the cell, in this case is used to rest connector cell

iconstringOptional

Icon of the cell

personastringOptional

Persona of the cell

Responses
204

No Content

No content
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/massive?cellType=ANSWER&objectRef=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 321

{
  "cellName": "text",
  "description": "text",
  "expressionCode": "text",
  "cellEnable": true,
  "executionLimit": 1,
  "options": [
    {
      "cockpitUUID": "text",
      "urlRedirect": true,
      "buttonUrl": "text",
      "buttonType": "text",
      "buttonText": "text"
    }
  ],
  "template": "text",
  "tags": [
    {
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 1
    }
  ],
  "icon": "text",
  "persona": "text"
}
No content

Estabilishes a sequential connection between two existing cells.

put
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellOriginstringRequired

UUID of origin cell to connect

cellDestinationstringRequired

UUID of destination cell to connect

buttonUUIDstringRequired

UUID of button to connect if is service cell

Default: ""
directionstring · enumRequired

Direction that wants to know the possible connections. It can be left, bottom or right

Possible values:
Responses
204

No Content

No content
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?cellOrigin=text&cellDestination=text&buttonUUID=&direction=LEFT HTTP/1.1
Host: 
Accept: */*

No content

Change visibility of one cell

put
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 cell

botIdstringRequired

Uuid of the bot

objectRefstringRequired

Uuid of object to relationate. It can be intent, entity, service...

visibilitybooleanRequired

true if you want to make visible, false if not

Responses
204

No Content

No content
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/change-visibility HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "botId": "text",
  "objectRef": "text",
  "visibility": true
}
No content

Remove cells by its type

delete
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
cellTypestring · enumRequired

Enumeration of cell types.

Possible values:
objectRefstringRequired

Id of the object (intent, entity, service...

deleteInCascadebooleanOptional

True if wants to delete all children of the cell. False if wants to delete only the cell and converting it to Placeholder type

Default: false
Responses
204

No Content

No content
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type?cellType=ANSWER&objectRef=text HTTP/1.1
Host: 
Accept: */*

No content

PreviousDashboardNextEntity

Last updated

Was this helpful?