Get Extension Presence Status

Get Extension Presence Status is one of the Internal Data Ops operations. Point it at an extension and it looks up that extension’s live state, its presence profile, whether it is on a call, and whether it is ringing, then saves the answers in variables. Downstream components can read those variables to decide how the call should continue.

What it does

The component returns the current status of a single extension, covering:

• The extension’s presence profile.
• Whether the extension is on a call.
• Whether the extension is ringing.

You can select the extension from a list, or supply an expression so the target is worked out while the call is running. The lookup results are written to variables, ready to feed into a following component or to test in a Condition.

Configure the component

1. Drag the Internal Data Ops component onto the canvas, then click it to open its settings.

   

2. In the Component Type drop-down list, choose Get Extension Presence Status.

   

3. Point the component at an extension using one of these methods:

   

   • Extension: pick an extension from the drop-down list.

   • Expression: click the fx icon and enter an expression to resolve the extension at runtime.

     

     For example, $Session.ani uses the caller’s own number (Caller ID) as the extension to look up.

   Tip

   Pick Extension when you always want to check the same, fixed extension. Use an Expression when the extension to check depends on the call, for example when it should match the caller’s own number or a value collected earlier in the flow.

   Note

   For the variables and functions you can use in an expression, see Variables and Functions in Cloud Voice Expression.

4. Click Confirm in the bottom-right corner.

Variables

When you add a Get Extension Presence Status component, it writes the extension’s state into the variables below. Read them from any expression-aware component, Condition, for instance, to act on what the lookup returned.

Note

A call flow can hold more than one Get Extension Presence Status component, so each is numbered in the order you add it (Get Extension Presence Status 1, Get Extension Presence Status 2, and so on). Include the matching index in the variable name so you read from the right component.

Variable	Type	Description	Example
$GetExtensionStatus{index}.currentProfileName	String	The name of the extension’s current presence profile.	"Available"
$GetExtensionStatus{index}.currentProfile	String	The name of the current presence profile plus any extra detail attached to it.	"Available,work"
$GetExtensionStatus{index}.isUnavailable	Boolean	Whether the extension is unregistered, meaning no device is currently logged in to it.	False
$GetExtensionStatus{index}.isInCall	Boolean	Whether the extension is on a call. True means at least one endpoint registered to the extension is on a call; False means none are.	True
$GetExtensionStatus{index}.isInRing	Boolean	Whether the extension is ringing. True means at least one endpoint registered to the extension is ringing; False means none are.	False

Note

When you test currentProfileName in a function or condition, match one of the presence status names defined under PBX Settings > Preferences > Presence.

What it can connect to

A Get Extension Presence Status component leads to exactly one downstream component. Any of the following can follow it:

Component	Purpose
Prompt	Play an audio file or a text-to-speech message to the caller.
Business Hours	Route the call to different destinations depending on the time of day.
Menu	Offer callers a set of options and route them by the key they press (a DTMF, or Dual-Tone Multi-Frequency, tone: the sound a phone makes when a key is pressed).
User Input	Collect DTMF digits from the caller, usually paired with Condition to act on what was entered.
Language	Change the system prompt language for the rest of the flow.
Record	Start recording once the caller connects to another party, with optional notification prompts, or turn recording off for a call that would otherwise be recorded.
Dial by Number	Let callers dial a number directly to reach their destination.
Dial by Name	An end component that lets callers reach a user by typing the first three letters of their name.
Transfer	An end component that sends the caller to a chosen destination, with optional prompts announcing the transfer.
Hang Up Call	An end component that disconnects the call.
Condition	Route the call based on logical expressions.
Loop	Repeat a group of components a set number of times or until a condition is met.
Internal Data Ops	Read from and write to the Cloud Voice system’s own database. See Get Extension Presence Status, Set Extension Presence Status, Get Queue Agent, Get Queue Info, Get Agent Status, Set Agent Status, Get System Info, Get System Capacity, Get Extension Info, and Get Company Contact Info.
Email Sender	Send an email for real-time notifications, alerts, or user-specific information.
Database Access	Run a SQL operation against an external database during the call flow.
HTTP Request	Send an HTTP request to an external server to exchange data with a third-party service.