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

# Set Call Forwarding

> Let your AI agent set call forwarding rules after verifying the caller by extension and voicemail PIN.

**Set Call Forwarding** lets a verified caller change their call forwarding rules through the AI agent. The agent asks for the extension and voicemail PIN, then configures the dial rules that enable forwarding on your Voip UCAAS platform.

In the Add Functions picker, **Set Call Forwarding** is described as: "Set call forwarding rules for a user. Requires extension and voicemail PIN for verification. Configures dial rules that enable call forwarding."

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

## Prerequisites

1. Voip UCAAS connected on the AI agent (steps below).
2. Callers who know their extension and voicemail PIN.
3. **NS Set Call Forwarding** 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 **Set Call Forwarding**.
5. On the function card, fill in the instruction textbox: *"Describe when and how your agent should use this function to set call forwarding rules."*
6. Click **Save Changes**. You should see **Agent updated successfully!**

## Example instructions

```plaintext theme={null}
When a caller wants their calls forwarded to their mobile for the day, verify their extension and voicemail PIN, confirm the destination number, then set call forwarding. Read the new setting back before ending the call.
```

```plaintext theme={null}
If the caller asks to turn forwarding off, verify them first, clear forwarding, and confirm it is off.
```

## Tips

* Always verify the extension and voicemail PIN before changing forwarding.
* Confirm the destination number digit-by-digit before saving.
* Remind the caller that forwarding stays on until they turn it off—do not leave a test forward in place after a demo.
* If your platform also supports reading or clearing forwarding through the same capability, say clearly in instructions whether the caller wants to set, check, or remove forwarding.


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