jauharibill/sample-php

Citcall REST API for PHP. API support for Synchchronous Miscall, Asynchronous miscall, and SMS.

Citcall Library for PHP

This is the PHP client library for use Citcall's API. To use this, you'll need a Citcall account and Your IP has been filtered in citcall system. See citcall documentation for more information. This is currently a beta release.

Installation

Install with Composer

To install the PHP client library to your project, we recommend using Composer.

composer require citcall/api:dev-master

You don't need to clone this repository to use this library in your own projects. Use Composer to install it from Packagist.

If you're new to Composer, here are some resources that you may find useful:

• Composer's Getting Started page from Composer project's documentation.
• A Beginner's Guide to Composer from the good people at ScotchBox.

Install source from GitHub

To install the source code:

$ git clone git://github.com/citcall/sample-php.git

And include it in your scripts:

require_once '/path/to/src/Citcall.php';

Usage

If you're using Composer, make sure the autoloader is included in your project's bootstrap file:

require_once "vendor/autoload.php";

Create a citcall with your userid and API key:

$citcall = new Citcall\Citcall(USERID,APIKEY);

Examples

Synchronous miscall

To use Citcall's Miscall Sync API to send an Synchronous miscall, call the $citcall->sync_miscall() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

$sync_miscall = $citcall->sync_miscall([
	'msisdn' => MSISDN,
	'gateway' => GATEWAY
]);

If you want to able to do verify later use this example.

$sync_miscall = $citcall->sync_miscall([
	'msisdn' => MSISDN,
	'gateway' => GATEWAY,
	'valid_time' => TIME_VALID,
	'limit_try' => LIMIT_TRY
]);

The API response data can be accessed as array properties of the sync_miscall.

print_r($sync_miscall);

Asynchronous miscall

To use Citcall's Miscall Async API to Asynchronous miscall, call the $citcall->async_miscall() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

$async_miscall = $citcall->async_miscall([
	'msisdn' => MSISDN,
	'gateway' => GATEWAY
]);

If you want to able to do verify later use this example.

$async_miscall = $citcall->async_miscall([
	'msisdn' => MSISDN,
	'gateway' => GATEWAY,
	'valid_time' => TIME_VALID,
	'limit_try' => LIMIT_TRY
]);

The API response data can be accessed as array properties of the async_miscall.

print_r($async_miscall);

Callback Asynchronous miscall

To add callback on dashboard It is still manually doing by Citcall’s administrator, please send the callback url to our team.

See this Example to use callback.

Verify MOTP

To use Citcall's Verify MOTP API to verify MOTP, call the $citcall->verify_motp() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

$verify_motp = $citcall->verify_motp([
	'msisdn' => MSISDN,
	'trxid' => TRXID,
	'token' => TOKEN
]);

The API response data can be accessed as array properties of the verify_motp.

print_r($verify_motp);

SMS

To use Citcall's SMS API to send an SMS message, call the $citcall->sms() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

$sms = $citcall->sms([
	'senderid' => 'citcall',
	'msisdn' => MSISDN,
	'text' => 'Test message from the Citcall PHP'
]);

The API response data can be accessed as array properties of the sms.

print_r($sms);

SMS OTP

To use Citcall's SMS API to send an SMS message with token or we can call it SMSOTP, its pretty similiar like sms reguler as well, but there is an added token inside, to use it you can call the $citcall->smsotp() method.

The API can be called directly, using a simple array of parameters, the keys match the parameters of the API.

$token = random_int(10000, 99999); // example generate token

$smsotp = $citcall->sms([
	'senderid' => 'citcall',
	'msisdn' => MSISDN,
	'text' => 'Test message from the Citcall PHP XXXXX', // "XXXXX" will replaced by token param automatically
	'token' => $token,
]);

The API response data can be accessed as array properties of the sms.

print_r($smsotp);

Callback SMS

To add callback on dashboard It is still manually doing by Citcall’s administrator, please send the callback url to our team.

See this Example to use callback.

Contribute

1. Check for open issues or open a new issue for a feature request or a bug
2. Fork the repository on Github to start making your changes to the master branch (or branch off of it)
3. Write a test which shows that the bug was fixed or that the feature works as expected
4. Send a pull request and bug us until We merge it