KudiSMS PHP

KudiSMS Documentation

KudiSMS PHP is a PHP wrapper library for KudiSMS.

Quick Start

Installation

composer require toneflix-code/kudi-sms-php

Configure environment

Variable	Required	Description
KUDISMS_GATEWAY	No	Your prefered gateway
KUDISMS_API_KEY	Yes	Your API key
KUDISMS_SENDER_ID	Yes	SMS Sender ID
KUDISMS_TEST_NUMBERS	No	Numbers to use when running tests

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
);

Corporate SMS

To send using the corporate endpoint call the chainable corporate method before calling the send or sendBulk methods.

$instance->corporate()->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

• Legacy
• All Contributors

License

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