Learn about the Flow Management API Step object
Each Step is part of a Flow. Steps are used by the AI engine to determine what reply action to send when for example an intent is matched.
Steps can be related to other steps and configure complex tree-like dialog structures.
Parameter | Description | Type |
---|---|---|
stepId | Unique ID of the Step | string |
title | Name of the Step | string |
type | Type of step. Should be a value of INTENT , EVENT , UNKNOWN , IMAGE , FILE , AUDIO , VIDEO , LOCATION , NOTHING , ANYTHING . | string |
contexts | Collection of stepIds that precede the step | array |
intent | Intent object, required if type is INTENT |
{
"stepId": "EXAMPLE-8c96-442b-9871-7fc9be322da1",
"title": "Hello!",
"type": "INTENT",
"contexts": [],
"actions": [{
"type": "TEXT",
"payload": {
"texts": [
"Simple reply"
],
"quickReplies": [],
"tags": []
}
}],
"intent": {
"intentId": "EXAMPLE-31b1-45b3-b939-3879dfd377de",
"title": "Hello_World_Greeting",
"createdAt": "2018-10-24T06:45:19.484Z",
"examples": [{
"entities": [],
"query": "Hello"
}, {
"entities": [],
"query": "hi"
}, {
"entities": [],
"query": "Hey"
}]
}
}
{
"stepId": "STEP-9c2e-4cd4-9fdc-11fc1d31dfb8",
"type": "EVENT",
"title": "EVENT NAME",
"contexts": ["CONTEXT-8c96-442b-9871-7fc9be322da1"],
"actions": [{
"type": "TEXT",
"payload": {
"texts": [
"Simple reply"
],
"quickReplies": [],
"tags": []
}
}]
}