StartOutboundChatContact

typed block

Initiate an outbound chat contact to a customer. Only SMS chats are supported. For more information, see the StartOutboundChatContact in the Amazon Connect API Reference.

Factories

`StartOutboundChatContact`

StartOutboundChatContact() -> StartOutboundChatContactHandle

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

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

`StartOutboundChatContact`

StartOutboundChatContact(id: String) -> StartOutboundChatContactHandle

Construct a StartOutboundChatContact 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

`source_endpoint`

source_endpoint(value?: Map (SourceEndpoint)) -> StartOutboundChatContactHandle

Set the SourceEndpoint parameter.

Parameter	Type	Required	Description
`value`	`Map (SourceEndpoint)`	no

`destination_endpoint`

destination_endpoint(value?: Map (DestinationEndpoint)) -> StartOutboundChatContactHandle

Set the DestinationEndpoint parameter.

Parameter	Type	Required	Description
`value`	`Map (DestinationEndpoint)`	no

`contact_flow_arn`

contact_flow_arn(value?: String) -> StartOutboundChatContactHandle

Set the ContactFlowArn parameter. ContactFlowArn of the flow to be executed for the new outbound chat,

Parameter	Type	Required	Description
`value`	`String`	no	ContactFlowArn of the flow to be executed for the new outbound chat,

`contact_subtype`

contact_subtype(value?: String) -> StartOutboundChatContactHandle

Set the ContactSubtype parameter. Subtype of the new chat contact, currently only supports connect:SMS,

Parameter	Type	Required	Description
`value`	`String`	no	Subtype of the new chat contact, currently only supports connect:SMS,

`initial_system_message`

initial_system_message(value?: String) -> StartOutboundChatContactHandle

Set the InitialSystemMessage parameter. {

Parameter	Type	Required	Description
`value`	`String`	no	{

`content`

content(value?: String) -> StartOutboundChatContactHandle

Set the Content parameter. content of the initial system message to be sent to the DestinationEndpoint

Parameter	Type	Required	Description
`value`	`String`	no	content of the initial system message to be sent to the DestinationEndpoint

`related_contact`

related_contact(value?: String) -> StartOutboundChatContactHandle

Set the RelatedContact parameter. Only supported value is CURRENT

Parameter	Type	Required	Description
`value`	`String`	no	Only supported value is CURRENT

`next`

next(target: Handle) -> StartOutboundChatContactHandle

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

Wire an error transition for NoMatchingError: if no other Error matches.

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

`set_id`

set_id(id: String) -> StartOutboundChatContactHandle

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

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

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

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

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

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

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

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

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