CreateCallbackContact

typed block

Creates a new callback contact. If no customer number is specified, and this is run in context of a contact, the contact's CustomerCallbackNumber is used as the customer number. If you specify a ContactFlowId, then InitialCallDelaySeconds parameter is ignored.

Factories

CreateCallbackContact

CreateCallbackContact() -> CreateCallbackContactHandle

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

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

CreateCallbackContact

CreateCallbackContact(id: String) -> CreateCallbackContactHandle

Construct a CreateCallbackContact block with an operator-supplied id.

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

Methods

queue_id

queue_id(value?: String) -> CreateCallbackContactHandle

Set the QueueId parameter. A queue ID or queue ARN. The callback contact is routed with this queue, or if this is not specified, the contact's current TargetQueue. Must be specified fully statically or with a single valid JSONPath identifier.

ParameterTypeRequiredDescription
valueStringnoA queue ID or queue ARN. The callback contact is routed with this queue, or if this is not specified, the contact's current TargetQueue. Must be specified fully statically or with a single valid JSONPath identifier.

agent_id

agent_id(value?: String) -> CreateCallbackContactHandle

Set the AgentId parameter. An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. This must be either defined fully statically or as a single valid JSONPath identifier.

ParameterTypeRequiredDescription
valueStringnoAn agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. This must be either defined fully statically or as a single valid JSONPath identifier.

initial_call_delay_seconds

initial_call_delay_seconds(value: i64) -> CreateCallbackContactHandle

Set the InitialCallDelaySeconds parameter. The amount of time, in seconds, to wait at a minimum before routing the callback contact. This gives the customer enough time to end their existing contact before being called back. Must be larger than 0, no greater than 259,200 (three days), and an integer. Must be defined statically.

ParameterTypeRequiredDescription
valuei64yesThe amount of time, in seconds, to wait at a minimum before routing the callback contact. This gives the customer enough time to end their existing contact before being called back. Must be larger than 0, no greater than 259,200 (three days), and an integer. Must be defined statically.

maximum_connection_attempts

maximum_connection_attempts(value: i64) -> CreateCallbackContactHandle

Set the MaximumConnectionAttempts parameter. The number of attempts at a maximum to connect this contact to a customer, if the callback is not answered. Must be larger than zero, and an integer. Must be defined statically.

ParameterTypeRequiredDescription
valuei64yesThe number of attempts at a maximum to connect this contact to a customer, if the callback is not answered. Must be larger than zero, and an integer. Must be defined statically.

retry_delay_seconds

retry_delay_seconds(value: i64) -> CreateCallbackContactHandle

Set the RetryDelaySeconds parameter. The minimum amount of time to wait, in seconds, between an unanswered callback attempt is made and the next attempt to reach the customer. Must be larger than 0, no greater than 259,200 (three days), and an integer. Must be defined statically.

ParameterTypeRequiredDescription
valuei64yesThe minimum amount of time to wait, in seconds, between an unanswered callback attempt is made and the next attempt to reach the customer. Must be larger than 0, no greater than 259,200 (three days), and an integer. Must be defined statically.

contact_flow_id

contact_flow_id(value?: String) -> CreateCallbackContactHandle

Set the ContactFlowId parameter. A contactFlow ID or contactFlow ARN. Callback contact created will execute this flow post creation, if specified. This must be either defined fully statically or as a single valid JSONPath identifier.

ParameterTypeRequiredDescription
valueStringnoA contactFlow ID or contactFlow ARN. Callback contact created will execute this flow post creation, if specified. This must be either defined fully statically or as a single valid JSONPath identifier.

caller_id

caller_id(value?: String) -> CreateCallbackContactHandle

Set the CallerId parameter. A caller ID representing the phone number to use for the callback. This is what the customer sees when dialed. Must be a valid phone number claimed in your Amazon Connect instance. This must be either defined fully statically or as a single valid JSONPath identifier.

ParameterTypeRequiredDescription
valueStringnoA caller ID representing the phone number to use for the callback. This is what the customer sees when dialed. Must be a valid phone number claimed in your Amazon Connect instance. This must be either defined fully statically or as a single valid JSONPath identifier.

next

next(target: Handle) -> CreateCallbackContactHandle

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.

on_no_matching

on_no_matching(target: Handle) -> CreateCallbackContactHandle

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

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on NoMatchingError. if no other Error matches.

meta_use_dynamic

meta_use_dynamic(value?: bool) -> CreateCallbackContactHandle

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

ParameterTypeRequiredDescription
valueboolnoBlock-level summary toggle — true if any parameter on this block uses a dynamic JSONPath value.

set_id

set_id(id: String) -> CreateCallbackContactHandle

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

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

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

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

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

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> CreateCallbackContactHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> CreateCallbackContactHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).