Dynamic Variables for FlowBuilder
Note:
This feature is currently not available for users registered in the North America (NA) region.
Dynamic variables allow you to insert data dynamically into your flow when a flow or the widget inside it is triggered. Each widget supports a set of variables that are used to build the flow. One can also use their own set of pre-configured variables.
Use the dynamic variables inside the widgets by simply entering “ {{ “. The dropdown of all the supported variables is listed as soon as the double curly braces are entered.
To use your own set of pre-configured variables, enter them manually inside the double curly braces in this format "{{api:VARIABLE}}".
Dynamic Variables
The table lists Dynamic Variables compatible with Flowbuilder along with the description and widget compatibility.
| Dynamic Variable | Description | Widget Compatible |
|---|---|---|
| {{id}} | Specifies the unique identification of a call, also known as call id. | API. |
| {{flow_id}} | Specifies the unique identification of a flow. | API. |
| {{keypress}} | Specifies the last entered keypress value in the flow execution path. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{call_type}} | Specifies whether the call is Incoming or outgoing. | API |
| {{caller}} | Specifies the number from which the call is originated, also known as call originator. | Play and API. |
| {{bridge}} | Specifies the DID number used for making the call and triggering the flow. | Play, IVR Menu, Repeat, Keypress, API, and SMS. |
| {{callee}} | Specifies the number to which the call is received, also known as call recipient. | API and SMS. |
| {{starttime}} | Specifies the call start time in EPOCH format. | API and SMS. |
| {{flow_start_time}} | Specifies the flow start time in EPOCH format. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{trigger}} | Specifies whether the flow trigger type is Voice call or Webhook. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{caller.isdcode}}, {{bridge.isdcode}}, {{callee.isdcode}} | Specifies the ISD code of a caller, bridge, and callee numbers. | API. |
| {{caller.isocode}}, {{bridge.isocode}}, {{callee.isocode}} | Specifies the ISO code of a caller, bridge, and callee numbers. | API. |
| {{caller.country}}, {{bridge.country}}, {{callee.country}} | Specifies the country of the caller, bridge, and callee numbers. | Play, IVR Menu, Repeat, Keypress, API, and SMS. |
| {{keypress:WIDGETID}} | Specifies the entered keypress value of the given widget id in the flow execution path. Note: The WIDGETID needs to be replaced by the actual value. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{api:VARIABLE}} | Specifies the variable value from the last API response. Note: The VARIABLE needs to be replaced by the actual value. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{api:VARIABLE.CHILD}} | Specifies the variable value from the last API response, especially to access the child element. Note: The VARIABLE, and CHILD needs to be replaced by the actual values. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{api:WIDGETID:VARIABLE}} | Specifies the variable value from the last API response of the given widget id. Note: The WIDGETID*, and VARIABLE** needs to be replaced by the actual values. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
| {{api:WIDGETID:VARIABLE.CHILD}} | Specifies the variable value from the last API response of the given widget Id, especially to access the child element. Note: The WIDGETID, CHILD, and VARIABLE needs to be replaced by the actual values. | Play, IVR Menu, Repeat, Keypress, API, Call forward, and SMS. |
Updated 28 days ago