MessageParticipant

typed block

Sends a message to the participant. This is an audio prompt or text-to-speech for voice contacts, or a text message for other channels.

Factories

`MessageParticipant`

MessageParticipant() -> MessageParticipantHandle

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

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

`MessageParticipant`

MessageParticipant(id: String) -> MessageParticipantHandle

Construct a MessageParticipant 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) -> MessageParticipantHandle

Set the PromptId parameter. A prompt ID or prompt ARN to play to the participant along with gathering input. Must be specified either statically or as 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 specified either statically or as a single valid JSONPath identifier.

`text`

text(value?: String) -> MessageParticipantHandle

Set the Text parameter. An optional string that defines text to send to the participant along with gathering input. May be specified 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 specified statically or dynamically.

`ssml`

ssml(value?: String) -> MessageParticipantHandle

Set the SSML parameter. An optional string that defines SSML to send to the participant along with gathering input.

Parameter	Type	Required	Description
`value`	`String`	no	An optional string that defines SSML to send to the participant along with gathering input.

`media`

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

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

`skip_when_dtmf`

skip_when_dtmf(value?: bool) -> MessageParticipantHandle

Set the SkipWhenDTMFBufferEnabled parameter. When true, Connect skips playing this prompt if the caller has already entered DTMF into the buffer.

Parameter	Type	Required	Description
`value`	`bool`	no	When true, Connect skips playing this prompt if the caller has already entered DTMF into the buffer.

`next`

next(target: Handle) -> MessageParticipantHandle

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.

`on_no_matching`

on_no_matching(target: Handle) -> MessageParticipantHandle

Wire an error transition for NoMatchingError: If an error occurred and no other error matched.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. If an error occurred and no other error matched.

`meta_use_dynamic`

meta_use_dynamic(value?: bool) -> MessageParticipantHandle

Set Metadata.ActionMetadata[<id>].useDynamic. Block-level summary toggle — true if any parameter on this block uses a dynamic JSONPath value.

Parameter	Type	Required	Description
`value`	`bool`	no	Block-level summary toggle — true if any parameter on this block uses a dynamic JSONPath value.

`meta_prompt_name`

meta_prompt_name(value?: String) -> MessageParticipantHandle

Set Metadata.ActionMetadata[<id>].promptName. Display name of the prompt, shown in the Connect console UI.

Parameter	Type	Required	Description
`value`	`String`	no	Display name of the prompt, shown in the Connect console UI.

`set_id`

set_id(id: String) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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) -> MessageParticipantHandle

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

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