Prompt Number

'Prompt Number' is used when you need the user to enter a number.

When triggered, a message will be presented to the user, expecting the input to be a number.

In this prompt, you have the 'min', 'max', and 'step' operators. The default 'step' is 1.

Example

get_number:
type: prompt
prompt_type: number
min: 1
max: 5
step: 1
messages:
- 'choose a number between 1 and 5: '
on_complete:
go_to: get_text

Properties

Field

Type

Description

Example

step

number (int)

min

number (int)

max

number (int)

messages[]

object (MessageNodeItem)

on_complete

object (RoutingNode)

on_start

object

Used to invoke a function before the message is sent to the destination.

identifer

string

prompt_type

string

retries

number (int)

Number of total retries. Upon invalid response, users will be prompted again with the same prompt until a valid input is provided - or number of retries exceeded. If users exceed maximum number of retries, the fallback node will be triggered. If set to 0, there is no retries limit.

on_retry

object

when input fail, do X