kamrankhosa/laravel-voipnow

A laravel package to interact with voipnow API

1.0.0 2024-03-09 13:50 UTC

Requires

• php: ^8.1

Requires (Dev)

• larapack/dd: ^1.1
• phpunit/phpunit: ^10.5

MIT

• Kamran Haider

• voipnow
• 4psa
• laravel-voipnow
• voipnow-laravel-package
• kamrankhosa-voipnow

README

A laravel 10 package to interact with voipnow System API

Note: The token credential information will be stored to the users table, with token and expiry information for the authenticated user.

Installation

You can install the package via composer:

composer require kamrankhosa/laravel-voipnow

From the command-line run:

php artisan vendor:publish --provider="KamranKhosa\VoipNow\VoipNowServiceProvider"

Add the following keys to your .env file.

VOIPNOW_VERSION=
VOIPNOW_DOMAIN=
VOIPNOW_KEY=
VOIPNOW_SECRET=

The following key is optional

VOIPNOW_PARENT_IDENTIFIER=

Usage

You can call a VoipNow SystemAPI method directly by using the facace (e.g. VoipNow::{VOIPNOWFUNCTION}). For a full reference of all the available functions refer to the VoipNow SystemAPI documenatation.

Examples

Retrieve a list of all the service providers

use VoipNow;

return VoipNow::GetServiceProviders();

Retrieve the organization account details

use VoipNow;

return VoipNow::GetOrganizationDetails(['identifier' => 'XXX']);
OR
return VoipNow::GetOrganizationDetails(['ID' => 'XXX']);

If you do not use the Facade, you can call it with the app() helper.

$voipNow = app('voipnow');

return $voipNow->GetOrganizationDetails(['identifier' => 'XXX']);
OR
return $voipNow->GetOrganizationDetails(['ID' => 'XXX']);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Kamran Haider

Support

Please open an issue in github

License

The MIT License (MIT). Please see License File for more information.