> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/livevox-integration-setup.md).

# LiveVox Integration Setup

### Getting started

BalkanID recommends a dedicated API account provisioned by your LiveVox SmartReach account team. Do not use a personal login.

#### Requirements

Collect these values before you begin:

* **Client Name**
* **User Name**
* **Password**
* **Access Token**
* **Region** — NA3, NA4, NA5, or NA6

{% hint style="info" %}
LiveVox issues Configuration API credentials directly. Contact your LiveVox account team to provision an API account for BalkanID. Confirm your hosted region, from NA3 through NA6.
{% endhint %}

#### Obtain your LiveVox API credentials

1. Ask your LiveVox account team for a Configuration API account for BalkanID.
2. Request the **Sysadmin** or **Superuser** role. BalkanID needs one of these roles to list users, agents, and call centers.
3. Record the **Client Name**, **User Name**, **Password**, and **Access Token**. Also record the hosted **Region**: NA3, NA4, NA5, or NA6.

### Configure LiveVox within your BalkanID tenant

1. Sign in to BalkanID. Switch to the tenant where you want the integration.
2. Go to *Integrations* → **Add Integration**. Search for and select **LiveVox**.
3. Set the **Primary Application Owner**. Add a description and secondary owners if needed.
4. Under **Select Extraction Type**, keep **Direct Configuration** selected. Enter the **Client Name**, **User Name**, **Password**, and **Access Token**. Select the **Region**, then click **Next**.
5. Complete **Optional Configuration**, if required.
6. Click **Save**. BalkanID displays the integration with the others on the **Integrations** page. When data is available, its status is **Connected** and its message is **Data available**.

### What BalkanID extracts

| Type             | From LiveVox                                                                                                                         |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Users**        | Portal users, excluding agents, and the services they can access.                                                                    |
| **Agents**       | Call-center agents with their assigned services, skills, and call centers.                                                           |
| **Roles**        | Each user's role, such as Sysadmin or Superuser, and its permissions.                                                                |
| **Call Centers** | Call centers and their status.                                                                                                       |
| **Services**     | Services configured under each call center.                                                                                          |
| **Agent Skills** | Skills, assigned agents, and proficiency levels.                                                                                     |
| **Insights**     | Findings such as locked-out users with access, inactive accounts with access, or identities inactive for 90 days that retain access. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/livevox-integration-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.