CompleteOutboundCall

typed block

When a flow is run before an outbound call is made as part of an outbound contact, this action calls the outbound destination. If this action is not used, the first participant action implicitly completes the outbound call.

Factories

CompleteOutboundCall

CompleteOutboundCall() -> CompleteOutboundCallHandle

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

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

CompleteOutboundCall

CompleteOutboundCall(id: String) -> CompleteOutboundCallHandle

Construct a CompleteOutboundCall block with an operator-supplied id.

ParameterTypeRequiredDescription
idStringyesWire identifier, typically a Connect UUID restored by decompile so round-trips stay byte-stable.

Methods

number

number(value?: String) -> CompleteOutboundCallHandle

Set the Number parameter. The caller ID number to present when calling. Can either be fully static or a single valid JSONPath identifier

ParameterTypeRequiredDescription
valueStringnoThe caller ID number to present when calling. Can either be fully static or a single valid JSONPath identifier

voice_connector

voice_connector(value?: Map (VoiceConnector)) -> CompleteOutboundCallHandle

Set the VoiceConnector parameter. Optional, Configuration of the voice connector

ParameterTypeRequiredDescription
valueMap (VoiceConnector)noOptional, Configuration of the voice connector

connection_time_limit_seconds

connection_time_limit_seconds(value?: i64) -> CompleteOutboundCallHandle

Set the ConnectionTimeLimitSeconds parameter. Optional, Only used for Voice Connector use case. An integer between 1 and 600

ParameterTypeRequiredDescription
valuei64noOptional, Only used for Voice Connector use case. An integer between 1 and 600

next

next(target: Handle) -> CompleteOutboundCallHandle

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

ParameterTypeRequiredDescription
targetHandleyesThe block to route to once this block completes successfully.

set_id

set_id(id: String) -> CompleteOutboundCallHandle

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

ParameterTypeRequiredDescription
idStringyesWire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

meta_position

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

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.

ParameterTypeRequiredDescription
xi64yesCanvas X coordinate.
yi64yesCanvas Y coordinate.

set_meta

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

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

ParameterTypeRequiredDescription
keyStringyesWire key name (under Metadata.ActionMetadata[<id>]).
valueDynamicyesAny JSON-serializable Rhai value.

overwrite_meta

overwrite_meta(value: Map) -> CompleteOutboundCallHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement map for the entire ActionMetadata sub-object.

set_meta_param

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

Set a single per-parameter ActionMetadata flag.

ParameterTypeRequiredDescription
paramStringyesParameter name (e.g. "Text").
flagStringyesFlag name ("useDynamic", "MFLAG_*", etc.).
valueDynamicyesFlag value.

overwrite_meta_param

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

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> CompleteOutboundCallHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> CompleteOutboundCallHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).