Get Extension Info

This topic provides an overview of the Get Extension Info component, and describes its configuration, variables, as well as supported connections.

Component introduction

Get Extension Info component allows you to query extension information, including extension number, extension name, email address, and mobile number.

You can either specify the extension directly, or configure expressions to dynamically specify the target extension. The query results are stored in variables, which can be used as input for subsequent components or for condition evaluation.

Note: If multiple matches are found, the system returns the information of the most recently created extension.

Component configuration

  1. After adding Internal Data Ops component to a message flow, click Internal Data Ops component to proceed with the configuration.

  2. In the pop-up right panel, complete the following settings.

    1. In the Component Type drop-down list, select Get Extension Info.
    2. Specify the target extension using the following filters.
      Filter Description
      Keyword Enter a keyword to perform a fuzzy search for extensions by first name, last name, email address, or extension number.
      Name Enter extension's first name or last name.
      Email Enter extension's email address.
      Number Enter extension number.
      Extension Group Select extension group(s) to search extensions in these groups.
      Note: If no groups are configured, the system searches across all extension groups.
      Organization Select departments(s) to search extensions in these departments.
      Note:
      • This option is available only when Organization Management is enabled (Path: PBX Settings > Preferences > Organization Management).
      • If configured, the system searches extensions within the selected department(s) and their sub-departments. Otherwise, the system searches across all departments.
      Note: For Keyword, Name, Email and Number filters, you can click to configure expressions to dynamically filter the extensions.

      An expression may include variables, constants, and functions. You can enter FX to view and select system‑supported functions, and enter $ to view and select variables already stored in the current message flow.

      For more information about functions and variables, see Variables and Functions in Yeastar Expression.

    3. At the bottom-right corner, click Confirm.

      The configured information appears on the component.

  3. Optional: To route the message session or trigger other actions, hover over the component and click to add the next component.

    For more information about components that support to be connected, see Component connections.

Component variables

When a Get Extension Info component is added to a message flow, the system stores extension information in variables. These variables can be referenced in expression-supported components (such as Condition) to retrieve the extension information and respond accordingly based on the result.

Note: Since Get Extension Info component can be added multiple times in a message flow, an index is appended to the unique ID of each component (e.g. Get Extension Info 1, Get Extension Info 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
$GetExtensionInfo{index}.number String Extension number. "1001"
$GetExtensionInfo{index}.name String Extension name. "Phillip Huff"
$GetExtensionInfo{index}.email String Extension's email address. "phillip@sample.com"
$GetExtensionInfo{index}.mobileNumber String Extension's mobile number. "15880123456"

Component connections

Get Extension Info component can be connected to one component, which can be any of the components listed below.

Note: If a component is already connected to the component, and you need to insert a new one between them, hover over the line between them, click and select the target component. The selected one is inserted between them with connections auto-established on both ends, without the need to delete the connection, add the component and reconnect manually.

End components Transfer and Close are unavailable for this insertion method.

Component Description
Send Message Send Message component enables the system to automatically send messages to customers.

For more information, see Send Message.

Send WhatsApp Template Message Send WhatsApp Template Message component enables the system to automatically send messages to customers using specified WhatsApp message templates.
Important: This component is available only when the message flow is only applicable to WhatsApp channel type.

For more information, see Send WhatsApp Template Message.

Wait for Reply Wait for Reply component allows you to set the reply timeout and route the message session depending on whether a reply is received.

For more information, see Wait for Reply.

Menu Menu component allows you to present the customer with a set of menu options, and route the message session based on the value that they reply.

For more information, see Menu.

Business Hours

Business Hours component allows you to route the message session to different destinations based on the time of day.

For more information, see Business Hours.

Wait Wait component enables the system to automatically route the message session to the connected component upon reply timeout.

For more information, see Wait.

Condition Condition component allows routing the message session based on logical expressions.

For more information, see Condition.

Loop Loop component allows a group of components to be executed repeatedly based on the loop strategy.

For more information, see Loop.

Internal Data Ops Internal Data Ops component allows you to query data from PBX-native database.
For more information, see the following topics:
Email Sender Email Sender component enables the system to automatically send emails to a recipient via configured email server and record the send logs, enabling real-time notifications.

For more information, see Email Sender.

Database Access Database Access component allows you to interact with database during a message flow. You can execute SQL operations to retrieve or update data as needed.

For more information, see Database Access.

HTTP Request HTTP Request component allows you to send HTTP requests to external web servers, enabling data exchange with third-party services.

For more information, see HTTP Request.

Transfer

Transfer component allows you to transfer the message session to a specific destination to terminate the current message flow.

For more information, see Transfer.

Close Close component enables the system to automatically disconnect the message session to terminate the current message flow.

For more information, see Close.