DequeueContactAndTransferToQueue

typed block

This action is a combination of a "Dequeue" action and a "TransferContactToQueue" action. This means that a contact in a queue is removed from the queue, a new contact segment is created with the existing contact as its previous contact, and the new contact is placed into the specified queue (referred to as "Queue-to-queue transfer"). If this contact has not been queued, is actively being joined to an agent, or has been routed to an agent, this action fails.

Factories

DequeueContactAndTransferToQueue

DequeueContactAndTransferToQueue() -> DequeueContactAndTransferToQueueHandle

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

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

DequeueContactAndTransferToQueue

DequeueContactAndTransferToQueue(id: String) -> DequeueContactAndTransferToQueueHandle

Construct a DequeueContactAndTransferToQueue 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) -> DequeueContactAndTransferToQueueHandle

Set the QueueId parameter. A queue ID or queue ARN. If AgentId is specified, this may not be specified. Must be either fully statically defined or a single, valid JSONPath identifier.

ParameterTypeRequiredDescription
valueStringnoA queue ID or queue ARN. If AgentId is specified, this may not be specified. Must be either fully statically defined or a single, valid JSONPath identifier.

agent_id

agent_id(value?: String) -> DequeueContactAndTransferToQueueHandle

Set the AgentId parameter. An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. Must be either fully statically defined or 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. Must be either fully statically defined or a single, valid JSONPath identifier.

next

next(target: Handle) -> DequeueContactAndTransferToQueueHandle

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_queue_at_capacity

on_queue_at_capacity(target: Handle) -> DequeueContactAndTransferToQueueHandle

Wire an error transition for QueueAtCapacity: if the destination queue is at capacity and the contact cannot be queued within it.

ParameterTypeRequiredDescription
targetHandleyesBlock to route to on QueueAtCapacity. if the destination queue is at capacity and the contact cannot be queued within it.

on_no_matching

on_no_matching(target: Handle) -> DequeueContactAndTransferToQueueHandle

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

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

set_id

set_id(id: String) -> DequeueContactAndTransferToQueueHandle

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

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

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

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

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

Replace the entire flag map for one parameter.

ParameterTypeRequiredDescription
paramStringyesParameter name.
valueMapyesReplacement flag map for the parameter.

overwrite_parameters

overwrite_parameters(value: Map) -> DequeueContactAndTransferToQueueHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement parameter map for the block.

raw_transitions

raw_transitions(value: Map) -> DequeueContactAndTransferToQueueHandle

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

ParameterTypeRequiredDescription
valueMapyesReplacement transitions map (raw JSON shape).