steevenz/citcall

Citcall API PHP Library


Keywords
api, citcall
License
MIT

Documentation

Citcall API

Scrutinizer Code Quality Build Status Latest Stable Version Total Downloads License

Citcall API PHP Class Library berfungsi untuk melakukan request API pengiriman SMS dan Call menggunakan Citcall.

Instalasi

Cara terbaik untuk melakukan instalasi library ini adalah dengan menggunakan Composer

composer require steevenz/citcall

Penggunaan

use Steevenz\Citcall;

/*
 * --------------------------------------------------------------
 * Inisiasi Class Citcall
 *
 * @param string Username
 * @param string API Key
 * --------------------------------------------------------------
 */
 $citcall = new Citcall([
   'version'  => 'v3', // default v3
   'appName'  => 'My App',
   'userId'   => 'USERID',
   'senderId' => 'SENDERID',
   'apiKey'   => 'APIKEY',
   'retry'    => 5, // default 5
]);

/*
 * --------------------------------------------------------------
 * Melakukan send sms
 *
 * @param string Phone Number
 * @param string Text
 *
 * @return object|bool
 * --------------------------------------------------------------
 */
 $result = $citcall->send('082123456789','Testing Citcall SMS API');

/*
 * --------------------------------------------------------------
 * Melakukan missed call otp
 *
 * @param string Phone Number
 * @param int    Gateway number (1-5) (1 by default)
 * @param bool   Asyncronous Missed Call (false by default)
 *
 * @return object|bool
 * --------------------------------------------------------------
 */
 $result = $citcall->missedCallOtp('082123456789', 1, false);

/*
 * --------------------------------------------------------------
 * Melakukan send sms otp
 *
 * @param string  Phone Number
 * @param string  Token
 * @param seconds Expires
 *
 * @return object|bool
 * --------------------------------------------------------------
 */
 $result = $citcall->sendOtp('082123456789','KODE123', 3600);

/*
 * --------------------------------------------------------------
 * Melakukan verifikasi otp
 *
 * @param string  Transaction ID (TRXID)
 * @param string  Phone Number
 * @param string  Token
 *
 * @return object|bool
 * --------------------------------------------------------------
 */
 $result = $citcall->verifyOtp(123,'082123456789','KODE123');

/*
 * --------------------------------------------------------------
 * Mendapatkan callback result
 *
 * @return object
 * --------------------------------------------------------------
 */
$result = $citcall->getCallback();

Ide, Kritik dan Saran

Jika anda memiliki ide, kritik ataupun saran, anda dapat mengirimkan email ke steevenz@stevenz.com. Anda juga dapat mengunjungi situs pribadi saya di steevenz.com

Bugs and Issues

Jika anda menemukan bugs atau issue, anda dapat mempostingnya di Github Issues.

Requirements