Extends

• ArchBaseActionTransfer

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionTransferToAcd'.

static, readonly isArchActionTransferToAcd :boolean

Returns true indicating that this is an ArchActionTransferToAcd instance.

readonly appendSkills :ArchValueBoolean

Returns whether or not existing conversation ACD skills should be appended or overwritten. If the runtime value evaluates to true, the skills will be appended. Any other value, false or a NOT_SET boolean, will result in the skills being overwritten. Setting values on this property is only valid when the Transfer to ACD action is in an Inbound Email flow.

readonly directAgent :ArchValueUser

If specified, this indicates the agent to attempt to route to first and takes priority over preferredAgents settings.

readonly failureOutputs :ArchNamedValueList

List of properties with error information about failed transfers

Inherited From:

• ArchBaseActionTransfer#failureOutputs

readonly failureTransferAudio :ArchAudio

The failure transfer audio to play on the call in the even the transfer fails at runtime.

Inherited From:

• ArchBaseActionTransfer#failureTransferAudio

inQueueHandlingFlowInfo :ArchFlowInfoBasic

The in-queue flow that should be used while the call is in the target queue. Note that the setter will also accept an {ArchFlowInfo} instance as well as an {ArchFlowInfoBasic} instance. The in-queue flow needs to be the appropriate in-queue type for the parent flow of this action. For example, if this action was in an inbound call flow, you'd want to use an in-queue call flow info object when calling the setter.

readonly inQueueHandlingFlowType :string

This reflects the flow type that should be used when specifying the flow info supplied to the ArchActionTransferToAcd#inQueueHandlingFlowInfo property. If no in-queue override flow type is applicable in this action instance, nothing is returned. An example of when an override flow type is not available is when a Transfer to ACD action is used in an Inbound Chat flow since there isn't any In-Queue Chat flow type.

readonly languageSkill :ArchValueLanguageSkill

The language skill for this transfer to acd action.

readonly preferredAgents :ArchValueAgentScorePairCollection

Returns the agent score pair collection value for this action where you can specify preferred agents on the transfer at runtime. There is a MakeListAgentScorePair function that will combine User and score information in to an AgentScorePair collection at runtime. Similarly there is also a MakeAgentScorePair function which creates an individual instance of an AgentScorePair. Here's example expression text that creates an agent score pair collection from an agent score pair instance created with the User value in the Task.myPreferredAgent variable with a score of 50:

MakeList(MakeAgentScorePair(Task.myPreferredAgent, 50))

Or we can use the MakeListAgentScorePair function that will combine two lists together and return an agent score pair collection. For this example we will have another preferred agent User stored in the Task.myAgent2 variable and a routing score for that agent in a Task.myAgent2Score integer variable:

MakeListAgentScorePair(MakeList(Task.myPreferredAgent, Task.myPreferredAgent2), MakeList(50, Task.myAgent2Score))

readonly preTransferAudio :ArchAudio

The pre transfer audio to play on the call.

Inherited From:

• ArchBaseActionTransfer#preTransferAudio

readonly priority :ArchValueInteger

The integer priority for this transfer to acd action. The available range of priority values is >= -25000000 and <= 25000000.

readonly skills :ArchBaseSkillValuePairs

The skills collection for this transfer to acd action.

readonly targetQueue :ArchValueQueue

The target queue for this transfer action.

Methods

addLiteralBySkillNameAsync(skillName, callbackFunctionopt) → {Promise.<ArchActionTransferToAcd>}

This adds a skill by name to this Transfer to Acd action.

Parameters:

Name	Type	Attributes	Description
skillName	string		the name of the skill to add. Skill name lookups are performed case sensitively.
callbackFunction	callbackArchActionTransferToAcd	<optional>	a callback function to call if the skill is successfully looked up and configured on this action. The first parameter passed to the callback function will be this transfer to ACD action instance.

Returns:

Promise.<ArchActionTransferToAcd>

setLiteralByQueueIdAsync(queueId, callbackFunctionopt) → {Promise.<ArchActionTransferToAcd>}

This helper method sets the queue to transfer to by accessing the ArchActionTransferToAcd#targetQueue property and then calls the ArchValueQueue#setLiteralByQueueIdAsync method passing the submitted queue identifier through to that method.

Parameters:

Name	Type	Attributes	Description
queueId	string		the identifier of the queue to set
callbackFunction	callbackArchActionTransferToAcd	<optional>	a callback function to call if the queue is successfully looked up and configured on this action. The first parameter passed to the callback function will be this transfer to ACD action instance.

Returns:

Promise.<ArchActionTransferToAcd>

setLiteralByQueueNameAsync(queueName, callbackFunctionopt) → {Promise.<ArchActionTransferToAcd>}

This helper method sets the queue to transfer to by accessing the ArchActionTransferToAcd#targetQueue property and then calls the ArchValueQueue#setLiteralByQueueNameAsync method passing the submitted queue name through that method.

Parameters:

Name	Type	Attributes	Description
queueName	string		the name of the queue to set
callbackFunction	callbackArchActionTransferToAcd	<optional>	a callback function to call if the queue is successfully looked up and configured on this action. The first parameter passed to the callback function will be this transfer to ACD action instance.

Returns:

Promise.<ArchActionTransferToAcd>

useDefaultInQueueHandling()

This configures the Transfer to ACD action to use default in-queue handling. When an instance of a Transfer to ACD action is initially created, that is the default state of the action.