toneflix-code / kudi-sms-php
A PHP wrapper for KudiSMS.
Requires
- php: ^8.1|^8.2|^8.3
- toneflix-code/messaging-interface: 1.0
- vlucas/phpdotenv: ^5.6@dev
Requires (Dev)
- guzzlehttp/guzzle: ^7.0
- pestphp/pest: 2.x-dev
README
KudiSMS PHP is a PHP wrapper library for KudiSMS.
Quick Start
Installation
composer require toneflix-code/kudi-sms-php
Configure environment
Usage
Initialize
To initialize, simply call create new instance of the SmsSender
class.
use ToneflixCode\KudiSmsPhp\SmsSender; $instance = new SmsSender();
Optionally you can pass your sender ID
and API key
as parameters to the instance if you're unable to use environment variables.
use ToneflixCode\KudiSmsPhp\SmsSender; $instance = new SmsSender('SenderID', 'APIKey');
Send OTP
Call the sendOtp
method with the recipient, otp, appnamecode and templatecode as parameters.
$instance->sendOtp( recipient: '0807...', otp: string, appnamecode: string, templatecode: string );
Send to a single number
Call the send
method with the number and message as parameters.
$instance->send( recipient: '0807...', message: string );
Send to a multiple numbers
Call the sendBulk
method with an array of numbers and message as parameters.
$instance->sendBulk( recipients: ['0807...', '0903...'], message: string );
Coporate SMS
To send using the coporate endpoint call the chainable coporate
method before calling the send
or sendBulk
methods.
$instance->coporate()->send( recipient: '0807...', message: string );
Initialize Voice Messaging
To initialize, simply call create new instance of the VoiceSender
class.
use ToneflixCode\KudiSmsPhp\VoiceSender; $instance = new VoiceSender();
Optionally you can pass your Caller ID
and API key
as parameters to the instance if you're unable to use environment variables.
use ToneflixCode\KudiSmsPhp\SmsSender; $instance = new SmsSender('CallerId', 'APIKey');
Send voice message
Call the send
method with the number and a valid audio file url as parameters.
$instance->send( to: '0807...', url: string );
Send text to speach message
Call the tts
method with the number and message as parameters.
$instance->tts( to: '0807...', message: string );
Testing
$ composer test
All tests are available withing the tests
directory, most are skipped as the service is not free, you can also write your own tests.
Contributors
License
The MIT License (MIT). Please see License File for more information.