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.
Flows
Pagination and Listings
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is the status of the flow, represents whether it is active, default value true
true
It is the number of pages that will be returned, default value 0
0
Example: 1
It is the number of Flow per page, default value 5
5
Example: 1
It is the flow attribute used for the page, default attribute name
name
It is the sorting type, default value ASC
ASC
It is the parameter that contains the user data entry, that will be used to filter the flows
It is an identifier provided by the API client that will be used to identify distributed logs.
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,
"first": true,
"last": true,
"pageable": {
"paged": true,
"unpaged": true,
"pageNumber": 1,
"pageSize": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"offset": 1
},
"numberOfElements": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"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,
"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.
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is the parameter used to search for flows related to the entered value
It is an identifier provided by the API client that will be used to identify distributed logs.
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/quicksearch?name=text HTTP/1.1
Host:
Accept: */*
[
"text"
]
CRUD Operations
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is the uuid used to search for a Flow
It is an identifier provided by the API client that will be used to identify distributed logs.
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": {}
}
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is an identifier provided by the API client that will be used to identify distributed logs.
The object that contains the data needed to create a Flow
Name of the flow.
Description of the flow.
The flow type shall refer to:
1 - USER_JOURNEY
2 - WELCOME
3 - NOT_EXPECTED
4 - JUMP
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"
}
]
}
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is the uuid used to search for the Flow that will be updated
It is an identifier provided by the API client that will be used to identify distributed logs.
The object that contains the data needed to create a Flow
Name of the flow.
Description of the flow.
The flow type shall refer to:
1 - USER_JOURNEY
2 - WELCOME
3 - NOT_EXPECTED
4 - JUMP
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"
}
]
}
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is the uuid used to search for the Flow that will be deleted
It is an identifier provided by the API client that will be used to identify distributed logs.
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 the remaining types that can still be created.
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is an identifier provided by the API client that will be used to identify distributed logs.
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/types-to-create HTTP/1.1
Host:
Accept: */*
[
"USER_JOURNEY"
]
Flow Tree
It is the organization where the flow is, used to connect to the correct database
It is the environment where the flow is, used to connect to the correct database
It is the bot where the flow is, used to filter Flows
It is the uuid used to search for a Flow
It is an identifier provided by the API client that will be used to identify distributed logs.
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"
}
],
"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"
}
],
"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"
}
}
Cells
CRUD Operations
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid cell Uuid
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"
}
],
"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"
}
],
"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"
}
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Uuid flow to insert the new cell
Uuid of the parent cell. Necessary if it is not the first cell of flow
Uuid of the button. Necessary if it's a service cell parent
""
Type of insertion
CHILDREN
Possible values: A body containing all necessary data to create a new cell
Name of the cell
Type of the cell
Description of the cell
Uuid of object to relationate. It can be intent, entity, service...
Expression code of the cell
Template of the cell. It's required if cell is code or rule type
Number of times that the cell has to execute repeatedly
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells?flowUUID=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 372
{
"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
}
]
}
[
{
"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"
}
],
"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"
}
],
"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"
}
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid cell Uuid
New button parent uuid
""
A body containing all necessary data to update cell
Name of the cell
Description of the cell
Uuid of object to relationate. It can be intent, entity, service...
Expression code of the cell
True if wants to enable cell or false if not
Template of the cell. It's required if cell is code or rule type
Number of times that the cell has to execute repeatedly
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 370
{
"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
}
]
}
No content
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid cell Uuid
True if wants to delete all children of the cell. False if wants to delete only the cell and converting it to Placeholder type
true
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID} HTTP/1.1
Host:
Accept: */*
No content
Auxiliary Methods
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A body containing all necessary data to create a new cell
Uuid of the bot
Uuid of object to relationate. It can be intent, entity, service...
true if you want to make visible, false if not
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
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Type of cell to list
DTO with the template of cell to valid
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"
}
Flow Tree
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid cell Uuid
Direction that wants to know the possible connections. It can be left, bottom or right
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
}
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
UUID of origin cell to connect
UUID of destination cell to connect
UUID of button to connect if is service cell
""
Direction that wants to know the possible connections. It can be left, bottom or right
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?cellOrigin=text&cellDestination=text&buttonUUID=&direction=LEFT HTTP/1.1
Host:
Accept: */*
No content
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Type of cell to list
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/start-flows?cellType=ANSWER 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"
}
],
"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"
}
],
"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"
}
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid flow Uuid
Uuid of the parent cell
Type of insertion
CHILDREN
Possible values: 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"
}
]
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
Type of cell to list
Id of the object intent, entity, service...
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"
}
]
Was this helpful?