Dynamic Variables for FlowBuilder

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 your flow. You can add your own set of pre-configured variables.

The dynamic variables are used inside your widget just by simply entering “ {{ “.
The Dropdown of all the supported variables is listed as soon as you enter the double curly braces.
Also, you can provide your own variables between “ {{ “ “ }} ”.

Dynamic Variables

Table 1-1 lists Dynamic Variables compatible with Flowbuilder along with the description and area of use.

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. The id is numeric in nature.

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 start time of a call in timestamp format. Default is EPOCH.

API, 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 Widget id of the keypress widget 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.





© 2020-2021 Kaleyra Inc. All rights reserved

Trademarks, logos and service marks displayed on this site are registered and unregistered trademarks of Kaleyra Inc.

Updated 11 days ago


Dynamic Variables for FlowBuilder


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.