TransferParticipantToThirdParty

Transfers the participant to a specified phone number or voice connector. Optionally continues flow running if the third party disconnects while the participant is still connected.

Parameter object

"ThirdPartyPhoneNumber": Optional, Only for phone number type. A phone number, in e.164 format, of the external number to which to transfer the contact. Ignored when using VoiceConnectors. May be defined statically or dynamically.
"ThirdPartyConnectionTimeoutSeconds": An integer, between 0 and 600 (inclusive) representing the number of seconds to wait for the third party to answer before canceling the third party call. Only used if ContinueFlowExecution is not False. Must be defined fully statically or as a single valid JSONPath identifier.
"ContinueFlowExecution": Optional, Only for phone number type. "True" or "False". If not defined or True, the flow continues running after the third party call finishes, if False the flow does not continue, as long as the phone call to the third party succeeds. Must be defined statically.
"ThirdPartyDTMFDigits": Optional, Only for phone number type. A series of DTMF digits to send to the third party when the call succeeds. Must be defined fully statically or as a single valid JSONPath identifier. Must be 50 or fewer characters chosen from numeric digits, comma, asterisk, and pound sign
"CallerId": { Optional, Only for phone number type, an override of the caller ID to present when dialing the third party
  "Number": The caller ID number to present when dialing the third party. Must be defined fully statically or as a single valid JSONPath identifier.
  "Name": The caller ID name to present when dialing the third party. May be defined statically or dynamically.
}
"VoiceConnector": { Optional, only for voice connector type. Contains the configuration of the voice connector 
   "VoiceConnectorType": Only support "ChimeConnector". Must be defined statically.
   "VoiceConnectorArn": The Arn of Voice Connector. Can be set statically or dynamically.
   "FromUser": The user who makes the call. Can be set statically or dynamically.
   "ToUser": The user who receives the call. Can be set statically or dynamically.
   "UserToUserInformation": Optional, SIP user to user information. Can be set statically or dynamically.
} 

Results and conditions

None. Conditions are not supported.

Errors

• ConnectionTimeLimitExceeded - the call has taken longer than the specified time limit to be answered by the third party, and has been canceled. Supported only when ContinueFlowExecution is True.

• CallFailed - The call was unable to connect successfully. Only supported when ContinueFlowExecution is True.

• NoMatchingError - if no other Error matches.

Restrictions

This action is only allowed by the Voice channel.

This action is allowed in contact flows, transfer flows, and customer queue flows.

Corresponding block in the UI

Transfer to phone number