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

# Chat Notification

> Let your AI agent send chat messages to PBX users on Voip UCAAS API v2.

**Chat Notification** lets your AI agent send a chat message to PBX users on your Voip UCAAS platform while a call is in progress—for example to alert a person that a caller is waiting or needs a callback.

> [!WARNING]
>
> Chat Notification requires Voip UCAAS **API v2**. On API **v1**, the picker shows: "Not available on Voip UCAAS API v1 — this function needs v2. Adding it here would have no effect on calls."

In the Add Functions picker, **Chat Notification** is described as: "Send chat messages to PBX Users."

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

## Prerequisites

1. Voip UCAAS connected on **API Version v2** (steps below).
2. A domain where PBX users can receive chat.
3. **NS Chat Notification** 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 **Chat Notification**.
5. On the function card, fill in the instruction textbox: *"Describe when and how your agent should use this function to send chat messages to PBX users."*
6. Click **Save Changes**. You should see **Agent updated successfully!**

## Example instructions

```plaintext theme={null}
If the caller asks for a person who does not answer, send a chat to that user's extension with the caller's name, number, and a one-sentence summary.
```

```plaintext theme={null}
When the caller agrees to a callback, chat the on-call user with the preferred time and phone number.
```

## Tips

* If Chat Notification is greyed out, reconnect Voip UCAAS with **API Version** set to **v2**.
* Say both *when* to chat and *what* to include (name, number, summary).
* This is a notification during the call—not a full two-way chat inbox in Telzino.


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