PHPackages                             nerthux/vicidial-php-api-wrapper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. nerthux/vicidial-php-api-wrapper

ActiveLibrary[API Development](/categories/api)

nerthux/vicidial-php-api-wrapper
================================

This is a wrapper to use Vicidial's API easily with PHP

20269PHP

Since Aug 6Pushed 3y ago5 watchersCompare

[ Source](https://github.com/nerthux/Vicidial-PHP-API-WRAPPER)[ Packagist](https://packagist.org/packages/nerthux/vicidial-php-api-wrapper)[ RSS](/packages/nerthux-vicidial-php-api-wrapper/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

\##Vicidial API PHP WRAPPER

**DISCLAIMER:** *VICIdial is a registered trademark of the Vicidial Group which i am not related in anyway.*

VICIDIAL is a software suite that is designed to interact with the Asterisk Open-Source PBX Phone system to act as a complete inbound/outbound contact center suite with inbound email support as well.

Vicidial has an AGENT API and NON AGENT API, this classes are intended to make it easier to use in PHP

- [http://vicidial.org/docs/NON-AGENT\_API.txt](http://vicidial.org/docs/NON-AGENT_API.txt)
- [http://vicidial.org/docs/AGENT\_API.txt](http://vicidial.org/docs/AGENT_API.txt)

### How to use it

[](#how-to-use-it)

#### Example 1: Update fields on agent screen

[](#example-1-update-fields-on-agent-screen)

```
require 'vicidialAgentAPI.php';

$fields['first_name'] = "John";
$fields['last_name'] = "Doe";
$fields['address1'] = "123 Fake St";

try {
        $vicidialAPI = new VicidialAgentAPI("127.0.0.1", "VicidialAPI", "gabriel", "Sup3rP4ss",true);
        $vicidialAPI->update_fields("gabriel", $fields);
} catch (Exception $e) {
            echo 'Exception: ',  $e->getMessage(), "\n";
}

```

#### Example 2: Hangup Call, Dispo it and Pause Agent

[](#example-2-hangup-call-dispo-it-and-pause-agent)

```
require 'vicidialAgentAPI.php';

try {
        $vicidialAPI = new VicidialAgentAPI("127.0.0.1", "VicidialAPI", "gabriel", "Sup3rP4ss",true);
        $vicidialAPI->pause("gabriel", "PAUSE");
        $vicidialAPI->hangup("gabriel");
        $vicidialAPI->dispo("gabriel", "SALE");
        $vicidialAPI->pause_code("gabriel", "BREAK");

} catch (Exception $e) {
            echo 'Exception: ',  $e->getMessage(), "\n";
}

```

\###TODO

This is a work in progress, still working on finish the Agent API, after that i will add a NON Agent API Class

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity25

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5568183?v=4)[Gabriel Covarrubias](/maintainers/nerthux)[@nerthux](https://github.com/nerthux)

---

Top Contributors

[![nerthux](https://avatars.githubusercontent.com/u/5568183?v=4)](https://github.com/nerthux "nerthux (19 commits)")

### Embed Badge

![Health badge](/badges/nerthux-vicidial-php-api-wrapper/health.svg)

```
[![Health](https://phpackages.com/badges/nerthux-vicidial-php-api-wrapper/health.svg)](https://phpackages.com/packages/nerthux-vicidial-php-api-wrapper)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M19](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k12](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)