Stages specifications

OnliveFlow uses a data structure to define each interaction stage. This data structure consists of two main parts: the stage specification and the specification related to the interaction process in general.

{
    "stage": {
        ...
    },
    "flow": {
        ...
    }
}

The stages have the following common fields:

FieldName	Type	Required	Description	Default
id	string	X	Unique identifier of the stage
type	string	X	Stage type, must be one of the types described below
title	string/transObject		Stage title, can be a string or a translation object
content	string/object		Stage description, can be a string or a translation object
initialNode	boolean		Defines if the stage is the initial stage of the flow	false
finalNode	boolean		Defines if the stage is the final stage of the flow	false
actions	array		List of available actions in the stage, optional	[]
footerContent	string/object		Footer information, optional

Stage Types

There are several types of stages, each adds different functionalities to the interaction process. These are the available stage types:

• Form
• Booking
• Geolocator
• Decision
• Information
• iCall
• iChat

Stage Actions

Actions are events that the user can perform in a stage, their goal is to select an option or advance in the interaction process. Actions have the following common fields:

FieldName	Type	Required	Description	Default
id	string	X	Unique identifier of the action
type	string	X	Action type, must be one of the types described below
title	string/transObject		Action title, can be a string or a translation object
variant	string		Action variant, can have the following values: primary, secondary	primary
nextStageId	string		Identifier of the stage to advance to when the action is performed

Stage Action Types

There are several types of actions, each adds different functionalities to the interaction process. These are the available action types:

• forward: Advances to the next stage.
• link: Opens an external link.
• icall: Initiates an iCall if any agent is available.