> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telzino.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Timeframe

> Let your AI agent read the active PBX timeframe (for example Office Hours or AfterHours) for prompt logic.

**Get Timeframe** lets your AI agent read which NetSapiens answering-rule timeframe is active for the PBX user behind the agent (for example **Office Hours**, **Holidays**, or **AfterHours**). Use it when instructions should change based on the current timeframe—for example greet differently after hours, or refuse bookings on holidays.

In the Add Functions picker, **Get Timeframe** is described as: "Get the current PBX user's timezone/timeframe. Use to determine the active timeframe (e.g., AfterHours) for prompt logic."

This function is available in the **Connect App** only.

## Prerequisites

1. Voip UCAAS connected on the AI agent (steps below).
2. Timeframes defined on the agent user's answering rules in NetSapiens (for example Office Hours and Holidays).
3. **NS Get Timeframe** unlocked for the organization in Feature Administration.

## Connect Voip UCAAS

NetSapiens functions only appear after Voip UCAAS is connected on the AI agent.

1. In the Connect App (**AI Agents** tile in the NetSapiens portal), open the agent list.
2. In the agent's row, click the **Integrations** icon (gear).
3. Click **Voip UCAAS** ("Connect to your UCaaS platform for subscriber management.").
4. In **Configure Voip UCAAS Integration**, fill in:
   * **API Version** — **v1** or **v2**. Start with **v1** unless you know your platform supports v2. Chat Notification needs **v2**.
   * **Voip UCAAS URL** — your platform API host (for example `https://core1.example.com`). `/ns-api/` is added automatically if it's missing.
   * **Username** — a user with **Domain Manager** or higher access in the agent's domain.
   * **Password** — leave blank to inherit saved reseller credentials when the form offers that.
   * **Domain** — the domain the AI agent lives in (usually pre-filled).
   * **Advanced** (optional) — **Client ID** / **Client Secret**. Leave blank unless your platform needs manually issued OAuth credentials; they're normally auto-detected.
5. Click **Connect**. The Voip UCAAS tile then shows **Connected**.

> [!TIP]
>
> If your reseller already saved credentials, you can leave **Password** (and Advanced secrets) blank to inherit them.

## Add the function

1. In the agent list, click the agent's pencil (**Edit**).
2. Under **Functions**, click **Add**.
3. Expand the **Voip UCAAS** group ("Functions powered by your UCaaS platform."). The group shows how many of the 8 functions are already added (for example `1 / 8 added`).
4. Click **Add** next to **Get Timeframe**.
5. On the function card, fill in the instruction textbox: *"Describe when and how your agent should use this function to get the current PBX user's timezone/timeframe."*
6. Click **Save Changes**. You should see **Agent updated successfully!**

## Example instructions

```plaintext theme={null}
When a caller asks whether you are open, use Get Timeframe. If the active timeframe is Office Hours, say you are open. If it is AfterHours or Holidays, say you are closed and offer to take a message.
```

```plaintext theme={null}
Before offering to book an appointment, check Get Timeframe. Only offer booking during Office Hours.
```

## Tips

* The function reads timeframes on the **agent user's** answering rules in NetSapiens, not a separate calendar in Telzino.
* Name the timeframes your instructions care about (for example Office Hours, Holidays) so the AI agent can match them.
* If the function fails with a phone-system permission error, re-check the Voip UCAAS username (Domain Manager or higher) and ask your partner or reseller to confirm API access to timeframes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.