> ## 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.

# NetSapiens Functions

> Connect Voip UCAAS in the Connect App and add NetSapiens-powered functions to your AI agent.

NetSapiens Functions let an AI agent use your NetSapiens-based UCaaS platform during a call: read office-hour timeframes, verify a caller by extension and voicemail PIN, look up the directory, set call forwarding, send and check SMS, reset a portal password, or notify PBX users by chat.

These functions are available in the **Connect App** (the **AI Agents** tile in the NetSapiens portal). They are not available in the Telzino Dashboard agent editor.

## Before you start

* An AI agent on a NetSapiens-based UCaaS platform in the Connect App.
* The **Netsapiens** / Voip UCAAS integration unlocked for the organization in [Feature Administration](https://docs.telzino.com/admin-guide/dashboard/feature-administration.md), plus each function you want to use (for example **NS Get Timeframe**, **NS Send SMS**).
* API credentials for a user with **Domain Manager** or higher in the agent's domain.

## 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 a NetSapiens function

After Voip UCAAS shows **Connected**:

1. Click the agent's pencil (**Edit**).
2. Under **Functions**, click **Add**.
3. Expand the **Voip UCAAS** group ("Functions powered by your UCaaS platform.").
4. Add the function you need, write instructions in the textbox, and click **Save Changes**.

| Function | What it does |
| - | - |
| [Get Timeframe](https://docs.telzino.com/netsapiens-functions/get-timeframe.md) | Get the current PBX user's timezone/timeframe. Use to determine the active timeframe (e.g., AfterHours) for prompt logic. |
| [Verify User](https://docs.telzino.com/netsapiens-functions/verify-user.md) | Verify a caller's identity by asking for their extension number and voicemail PIN. Use to authenticate users before providing sensitive information. |
| [Reset Password](https://docs.telzino.com/netsapiens-functions/reset-password.md) | Send the caller a link to reset their phone-system portal password, after verifying them by voicemail PIN. |
| [Lookup Directory](https://docs.telzino.com/netsapiens-functions/lookup-directory.md) | Check the Voip UCAAS directory of an organization. Use to transfer calls, get contact numbers, email addresses, or find other users in the organization. |
| [Set Call Forwarding](https://docs.telzino.com/netsapiens-functions/set-call-forwarding.md) | Set call forwarding rules for a user. Requires extension and voicemail PIN for verification. Configures dial rules that enable call forwarding. |
| [Send SMS](https://docs.telzino.com/netsapiens-functions/send-sms.md) | Send an SMS text message to an external phone number via Voip UCAAS. The agent's own SMS number is used as the sender. |
| [Check SMS Replies](https://docs.telzino.com/netsapiens-functions/check-sms-replies.md) | Check for recent inbound SMS/MMS replies sent to the agent's Voip UCAAS number. |
| [Chat Notification](https://docs.telzino.com/netsapiens-functions/chat-notification.md) | Send chat messages to PBX Users. Requires API v2. |

## Availability

Partners and resellers control these functions per organization in [Feature Administration](https://docs.telzino.com/admin-guide/dashboard/feature-administration.md). Each function has its own setting (for example **NS Get Timeframe**). All of them also depend on the **Netsapiens** integration setting. Locking the integration locks every NetSapiens function.

When a function is locked for an organization, it may still appear in the agent editor but is disabled (for example marked **Locked by your provider**). Ask your partner or reseller to unlock it.


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