pashamesh/comagic-api

PHP binding for UIScom (formerly CoMagic) API

0.5.0 2025-11-09 16:59 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^6.2|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.89
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^9.6
• rector/rector: ^2.2
• symfony/var-dumper: ^5.4 || ^6.4 || ^7.3 || ^8.0

MIT

• Pasha Mesh

• package
• php
• api
• sdk
• comagic
• uis
• uiscom
• uiscom sdk
• uiscom api
• uiscom dataapi
• uiscom callapi
• uiscom package

README

UIS (CoMagic) PHP client for the following APIs:

• Call API
• Data API

Requirements

This package requires PHP 7.4 or above.

Installation

To get started, install package via the Composer package manager:

composer require pashamesh/uiscom-api-client

Usage

Configuring

Array is using to configure Rest API and Call API clients.

$config = [
    // required for Rest API and optional for Call API
    'login' => 'put_login_here',
    'password' => 'put_password_here',
    // required for Call API if login and password not specified
    'access_token' => 'put_access_token_here',
];

You also need to change domain if you client of Uiscom by specifying endpoint:

use Uiscom\CallApiConfig;

$config = new CallApiConfig('login', 'password', 'access_token')

Do not forget to add Call API permissions to user if you want to use login and password authorization for Call API.

Call API

API Methods names need to be specified in CamelCase

use Uiscom\CallApiConfig;
use Uiscom\CallApiClient;

$config = new CallApiConfig('login', 'password', 'access_token');
$callApi = new CallApiClient($config);
var_dump($callApi->listCalls());

It's possible to get response metadata after API request is made

var_dump($callApi->metadata());

Data API

API Methods names need to be specified in CamelCase

use Uiscom\DataApiConfig;
use Uiscom\DataApiClient;

$config = new DataApiConfig('access_token');
$dataApi = new DataApiClient($config);
var_dump(
    $dataApi->getCallsReport([
        'date_from' => '2025-01-10 00:00:00',
        'date_till' => '2025-01-13 23:59:59'
    ])
);

It's possible to get response metadata after API request is made

var_dump($dataApi->metadata());