Get Extension Presence Status

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

Component introduction

Get Extension Presence Status component allows you to query current presence status of a specific extension.

You can either select a specific extension directly, or configure an expression 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.

Component configuration

After adding Internal Data Ops component to a message flow, click Internal Data Ops component to proceed with the configuration.
In the pop-up right panel, complete the following settings.
1. In the Component Type drop-down list, select Get Extension Presence Status.
2. In the Extension field, specify the target extension using one of the following methods.
  - Select an extension from the drop-down list.
  - Click beside the drop-down list, enter an expression and click Save.
    Note:
    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.
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 Presence Status component is added to a message flow, the system stores the extension's statuses in variables. These variables can be referenced in expression-supported components (such as Condition) to retrieve the status values and respond accordingly based on the result.

Note: Since Get Extension Presence Status 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 Presence Status 1, Get Extension Presence Status 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
$GetExtensionStatus`{index}`.currentProfileName	String	Name of the extension's current presence status. Note: When using functions to evaluate an extension's presence status, ensure that the status constant matches one of the values defined in PBX Settings > Preferences > Presence.	"Available"
$GetExtensionStatus`{index}`.currentProfile	String	Name and additional information of the extension's current presence status.	"Available,work"
$GetExtensionStatus`{index}`.isUnavailable	Boolean	Whether the extension is unregistered.	False

Component connections

Get Extension Presence Status 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: Get Extension Presence Status Get Extension Info Get Company Contact Info
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.