Download the PHP package xsme/php-api-adescom without Composer
On this page you can find all versions of the php package xsme/php-api-adescom. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xsme/php-api-adescom
More information about xsme/php-api-adescom
Files in xsme/php-api-adescom
Package php-api-adescom
Short Description PHP library for communication with Adescom PBX system via SOAP API
License MIT
Homepage https://github.com/xsme/php-api-adescom
Informations about the package php-api-adescom
PHP API Adescom
PHP library for handling Adescom system API using SOAP protocol.
Installation
Configuration
The library supports three different SOAP endpoints:
- Frontend - for managing clients and numbers
- Platform - for platform operations and billing
- Userpanel - for user panel operations
Initialization
Available methods
System information
getVersion(): string
Returns the PBX version.
Number management (CLID)
getClids(): stdClass
Returns a list of all numbers.
getClid(string $callerId): stdClass
Returns information about a specific callerID number.
getClidStatus(string $callerId): stdClass
Returns the status of a callerID number.
getClidsStatus(array $callerIds): stdClass
Returns statuses for multiple callerID numbers.
deleteClid(string $callerId, ?DateTime $dateTime = null): stdClass
Deletes a callerID number with optional date and time after which the number returns to the free numbers pool.
Number pool management
getPools(): stdClass
Returns a list of available number pools for the reseller.
getNumberPools(): stdClass
Returns a list of number pools.
getNumberPool(int $id): stdClass
Returns information about a specific number pool.
getFreeNumbersFromPool(int $id): stdClass
Returns a list of free numbers from the pool.
getFirstFreeNumberFromPool(int $id): stdClass
Returns the first free number from the pool.
Phone management
getPhones(): stdClass
Returns a list of phones.
getPhone(int $id): stdClass
Returns information about a specific phone.
Client management
getClients(): stdClass
Returns a list of all clients.
getClient(int $id): stdClass
Returns information about a specific client.
getClientByExternalId(string $externalID): stdClass
Returns a client by external ID.
getClidsForClient(int $clientId): stdClass
Returns a list of numbers for a specific client.
getClidsForClientByExternalId(string $externalID): stdClass
Returns a list of numbers for a client by external ID.
Billing and reports
getBillingByCallerID(DateTime $fromDate, DateTime $toDate, string $callerId, bool $includeZeroDuration = false, $typeSet = 1, int $directionSet = 1): stdClass
Returns billing records for the specified callerID number in the given time period.
Parameters:
$fromDate
- start date$toDate
- end date$callerId
- callerID number$includeZeroDuration
- whether to include calls with zero duration$typeSet
- set type (default 1)$directionSet
- call direction (1 or 2)
getBillingSummaryByCallerID(DateTime $fromDate, DateTime $toDate, string $calledId, bool $includeZeroDuration = false, $typeSet = 1, int $directionSet = 1): stdClass
Returns a summary of billing records for the specified callerID number in the given time period.
Parameters identical to getBillingByCallerID
Usage example
Requirements
- PHP 7.4 or higher
- SOAP extension
- OpenSSL extension (for HTTPS connections)
License
MIT License
All versions of php-api-adescom with dependencies
ext-soap Version *
ext-openssl Version *