pavlyuts/yate-api

This package is abandoned and no longer maintained. The author suggests using the yate-wireless/api package instead.

Yate wireless network core API wrapper

0.3 2022-01-07 12:54 UTC

Requires

• psr/log: ^1.1
• rmccue/requests: ^1.7

GPL-2.0-or-later

• Alexey Pavlyuts

• api
• yate

README

Purpose

This package intended to simplify communication to Yate core products from PHP application. Build for composer with PSR-4 autoload, uses PSR-3 object for logging.

Not properly tested, use at your own risk!

Classes available:

• Yate JSON API class wrapping general JSON API to most Yate comonent - both configuration and control.
• USSD gateway API class for USSD gateway interface for creating USSD applications
• USSD demo/test application, a good for learning and test USSD gateway interaction.
• USSD Menu/dialogue engine, for easy create USSD menus, dialogues and applications.
• USSD Menu handler, base class for menu handlers enriched with business logic.
• USSD Demo Menu handler, demo class, implementing simple USSD menus with examples of session vars management.

Please, refer project Wiki for details and usage example.

Installation

In the Composer storage. Just add proper require section:

"require": {
    "pavlyuts/yate-api": "*"
}

It is a good idea to fix the version you use. Don't use next version without review, I can't promose backward compatibility even will try to keep it. Please, review the changelog before to change used version.

Dependencies

• psr/log: ^1.1
• rmccue/requests: ^1.7

Yate documentation

Please, refer to Yate core network documentation:

• General JSON API
• USSD GW application API
• HSS subscriber management API
• SMSC SMS sending API

Also, API for configuration and control of each core component is documented and may be used with this wrapper.