GetParticipantInput

typed block

Gathers customer input (a DTMF collection for voice contacts, or an entered string for other channels). There are many optional behaviors after gathering this: encryption, validation, storing to a "LastParticipantInput" section on the flow run data, specifying a custom DTMF terminator for voice contacts and so on. Details are in the parameter object section.

Factories

`GetParticipantInput`

GetParticipantInput() -> GetParticipantInputHandle

Construct a fresh GetParticipantInput block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`GetParticipantInput`

GetParticipantInput(id: String) -> GetParticipantInputHandle

Construct a GetParticipantInput block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`prompt_id`

prompt_id(value?: String) -> GetParticipantInputHandle

Set the PromptId parameter. A prompt ID or prompt ARN to play to the participant along with gathering input. Must be either statically defined or a single valid JSONPath identifier.

Parameter	Type	Required	Description
`value`	`String`	no	A prompt ID or prompt ARN to play to the participant along with gathering input. Must be either statically defined or a single valid JSONPath identifier.

`text`

text(value?: String) -> GetParticipantInputHandle

Set the Text parameter. An optional string that defines text to send to the participant along with gathering input. May be defined statically or dynamically.

Parameter	Type	Required	Description
`value`	`String`	no	An optional string that defines text to send to the participant along with gathering input. May be defined statically or dynamically.

`ssml`

ssml(value?: String) -> GetParticipantInputHandle

Set the SSML parameter. An optional string that defines SSML to send to the participant along with gathering input. May be defined statically or dynamically.

Parameter	Type	Required	Description
`value`	`String`	no	An optional string that defines SSML to send to the participant along with gathering input. May be defined statically or dynamically.

`media`

media(value?: Map (Media)) -> GetParticipantInputHandle

Set the Media parameter. An optional object that defines an external media source

Parameter	Type	Required	Description
`value`	`Map (Media)`	no	An optional object that defines an external media source

`input_time_limit_seconds`

input_time_limit_seconds(value: i64 | JSONPath) -> GetParticipantInputHandle

Set the InputTimeLimitSeconds parameter. The number of seconds to wait for input to be collected before proceeding with a timeout error. For the Voice channel this is the timeout until the first DTMF digit is entered. Measured 2026-10-14: Connect accepts a whole number of at least 1 as a number or a string ("05", "+5", "500") and a parameter_value JSONPath, and refuses "0", "-1", "5.5", "1e1", " 5" and a boolean.

Parameter	Type	Required	Description
`value`	`i64 \| JSONPath`	yes	The number of seconds to wait for input to be collected before proceeding with a timeout error. For the Voice channel this is the timeout until the first DTMF digit is entered. Measured 2026-10-14: Connect accepts a whole number of at least 1 as a number or a string (`"05"`, `"+5"`, `"500"`) and a `parameter_value` JSONPath, and refuses `"0"`, `"-1"`, `"5.5"`, `"1e1"`, `" 5"` and a boolean.

`store_input`

store_input(value: String) -> GetParticipantInputHandle

Set the StoreInput parameter. "True" or "False". Must be statically defined.

Parameter	Type	Required	Description
`value`	`String`	yes	"True" or "False". Must be statically defined.

`input_validation`

input_validation(value?: Map (InputValidation)) -> GetParticipantInputHandle

Set the InputValidation parameter. An object that defines how to validate customer inputs, required if and only if StoreInput is True

Parameter	Type	Required	Description
`value`	`Map (InputValidation)`	no	An object that defines how to validate customer inputs, required if and only if StoreInput is True

`input_encryption`

input_encryption(value?: Map (InputEncryption)) -> GetParticipantInputHandle

Set the InputEncryption parameter. An optional object that defines how to encrypt the customer input. May only be specified if "CustomValidation" is provided.

Parameter	Type	Required	Description
`value`	`Map (InputEncryption)`	no	An optional object that defines how to encrypt the customer input. May only be specified if "CustomValidation" is provided.

`dtmf_configuration`

dtmf_configuration(value?: Map (DTMFConfiguration)) -> GetParticipantInputHandle

Set the DTMFConfiguration parameter. An optional object to override default DTMF behavior for voice calls

Parameter	Type	Required	Description
`value`	`Map (DTMFConfiguration)`	no	An optional object to override default DTMF behavior for voice calls

`next`

next(target: Handle) -> GetParticipantInputHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`when`

when(cond: ConditionHandle, target: Handle) -> GetParticipantInputHandle

Append a Conditions[] branch. Multiple .when(...) calls chain, evaluation runs in source order, first match wins.

Parameter	Type	Required	Description
`cond`	`ConditionHandle`	yes	Built from the `Cond::<op>(...)` namespace, e.g. `Cond::equals("42")`.
`target`	`Handle`	yes	Block to route to when the condition matches.

`on_no_matching_condition`

on_no_matching_condition(target: Handle) -> GetParticipantInputHandle

Wire an error transition for NoMatchingCondition: None of the specified conditions evaluated to true. Must be defined only if StoreInput is False.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingCondition`. None of the specified conditions evaluated to true. Must be defined only if StoreInput is False.

`on_no_matching`

on_no_matching(target: Handle) -> GetParticipantInputHandle

Wire an error transition for NoMatchingError: if no other Error matches. Must always be defined.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. if no other Error matches. Must always be defined.

`on_invalid_phone_number`

on_invalid_phone_number(target: Handle) -> GetParticipantInputHandle

Wire an error transition for InvalidPhoneNumber: the stored input was not a valid phone number according to the specified PhoneNumberValidation. Must be defined only if StoreInput is true, and PhoneNumberValidation is specified.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `InvalidPhoneNumber`. the stored input was not a valid phone number according to the specified PhoneNumberValidation. Must be defined only if StoreInput is true, and PhoneNumberValidation is specified.

`on_input_time_limit_exceeded`

on_input_time_limit_exceeded(target: Handle) -> GetParticipantInputHandle

Wire an error transition for InputTimeLimitExceeded: if there is no response before the configured InputTimeLimitSeconds.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `InputTimeLimitExceeded`. if there is no response before the configured InputTimeLimitSeconds.

`set_id`

set_id(id: String) -> GetParticipantInputHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> GetParticipantInputHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> GetParticipantInputHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> GetParticipantInputHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> GetParticipantInputHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> GetParticipantInputHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> GetParticipantInputHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> GetParticipantInputHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).