Transfer

This topic provides an overview of the Transfer component, and describes its configuration as well as supported connections.

Component introduction

Transfer component is one of the end components to terminate caller's connection to the current call flow. It allows you to blind transfer callers to a designated destination, and optionally configure prompts to inform them of the transfer.

Supported transfer destinations
  • Extension
  • Extension Voicemail
  • Ring Group
  • Queue
  • Group Voicemail
  • Conference
  • External Number
  • Call Flow
  • Custom
Supported prompt types
Prompt Type Description
Custom Prompt Choose from existing custom prompts, or create a new one by recording with an extension or uploading an audio file.
Music on Hold (MoH) Choose from existing MoH.
Note: Before you begin, make sure the desired MoH is configured in PBX Settings > Voice Prompt > Music on Hold.
Text to Speech (TTS)

Enter the desired text, which will be converted to speech in the selected language and voice style.

Note: Before you begin, make sure the Text-to-Speech feature is enabled in Integrations > AI.

Component configuration

  1. After adding Transfer component to a call flow, click Transfer component to proceed with the configuration.

  2. In the Destination drop-down lists, specify the destination where callers will be transferred.

    Option Description
    Extension Transfer incoming calls to a specific extension.
    Extension Voicemail Transfer incoming calls to a specific extension's voicemail.
    Ring Group Transfer incoming calls to a specific ring group.
    Queue Transfer incoming calls to a specific queue.
    Group Voicemail Transfer incoming calls to a specific group voicemail.
    Conference Transfer incoming calls to a specific conference.
    External Number Transfer incoming calls to a specific external number.
    Call Flow Transfer incoming calls to a specific call flow.
    Custom Transfer incoming calls to a custom destination.
    You can specify the destination in either of the following ways:
    • Directly specify a specific number: In the Destination Number field, enter a specific number.
    • Dynamically specify a number: Click to configure an expression.

      Example: $HttpRequest1.responseContent

      In this example, the system retrieves the on-duty phone number from a web-based calendar via the upstream HTTP Request 1 component, and routes incoming calls to that number.

      Note: For more information about the expression, see Variables and Functions in Yeastar Expression.

    If the custom destination has a voicemail box (e.g. extension voicemail or group voicemail), you can additionally enable Transfer to Voicemail to allow callers to reach the mailbox directly.

    Note: For External Number: If Filter Number is enabled (Path: PBX Settings > Preferences), the system will automatically remove all special characters (except digits, +, *, and #) from the custom number before sending to the trunk.
  3. Optional: Configure audio prompt(s) or a text-to-speech message to inform callers of the call transfer.
    Item Description
    Custom Prompt

    1. Click Custom Prompt.
    2. Specify custom prompt(s).
      Note: Up to 5 custom prompts are supported.
      • To choose from an existing prompt, select it from the drop-down list of Prompt.
      • To use a new prompt, click Record New to record prompt with an extension, or click Upload to upload an audio file.
        Note: The new prompt will be saved in PBX Settings > Voice Prompt > Custom Prompt.
    3. Optional: To play the custom prompt(s) in a loop, select the checkbox of Enable Loop Playback.
      Note: The looped prompt will be overridden if the next connected component is configured with a prompt.
    Music on Hold

    1. Select Music on Hold.
    2. Select an existing MoH from the drop-down list of Music on Hold.
    Text to Speech (TTS)
    1. Select Text to Speech.
    2. Complete the rest of the configurations to convert text into speech.
      Note: Both static text and dynamic text are supported to convert into speech.
      • Static text: Enter text directly in the Text field.
      • Dynamic text: Enter text and configure placeholders with corresponding variables to dynamically compose the text. Optionally, you can configure prompt generation timeout. If speech is not generated within the timeout period, caller will be routed to the next component without hearing a prompt.

        Example:

      The new speech will be saved to the system and synchronized to PBX Settings > Voice Prompt > Custom Prompt.
  4. At the bottom-right corner, click Confirm.

    The selected destination will appear on the component.

Component variable

When a Transfer component with TTS configured is added to a call flow, the system stores TTS result in variable. The variable can be referenced in expression-supported components, such as Condition or Developer, to retrieve the output value and flexibly route the call.

Note: Since Transfer component can be added multiple times in a call flow, an index is appended to each component (e.g. Transfer 1, Transfer 2) based on the order in which the components are added. To retrieve data from the right component, the component variable must contain the corresponding index.
Variable Type Description Example Value
$Transfer{index}.ttsResult String The Text-to-Speech (TTS) result of the Transfer component.
  • TransferTTSResult.Success: The text is successfully converted into speech, and the system plays it to caller.
  • TransferTTSResult.Timeout: The text is NOT converted into speech within the timeout period, and the system routes caller directly to the next component without playing a prompt when the timeout is reached.
 $Transfer1.ttsResult(STRING)=TransferTTSResult.Success

Component connections

Transfer component comes with a built-in Call End branch. This branch can be connected to one Developer component to interact with the PBX-native database or third-party database.

For more information about Developer component, see the following topics: