myckhel / checkmobi
CheckMobi APIs are based on HTTP methods, which make it easy to integrate into your own products.
Fund package maintenance!
Ko Fi
Installs: 560
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 1
Forks: 3
Open Issues: 0
Type:package
Requires
- illuminate/support: ~7|~8|~9|~10|~11
- nesbot/carbon: ^2.36.0
Requires (Dev)
- orchestra/testbench: ^5.0
This package is auto-updated.
Last update: 2024-10-12 08:40:58 UTC
README
CheckMobi Doc Link
Install
Via Composer
$ composer require myckhel/checkmobi
Setup
The package will automatically register a service provider.
You need to publish the configuration file:
php artisan vendor:publish --provider="Myckhel\CheckMobi\CheckMobiServiceProvider"
This is the default content of the config file checkmobi.php
:
<?php return [ "secret_key" => env("CHECKMOBI_SECRET_KEY"), "retry_after" => 120, // option to set the retry limit for each phone number verification /* coming soon */ "route_middleware" => 'auth:api', // For injecting middleware to the package's routes ];
Update Your Projects .env
with:
CHECKMOBI_SECRET_KEY=XXXXXXXXXXXXXXXXXXXX
Run the database migration
php artisan migrate
Available Api's
use CheckMobi; use Myckhel\CheckMobi\Support\MissedCall; CheckMobi::requestValidation($params); CheckMobi::verifyValidation($params); CheckMobi::getAccountDetails($params); CheckMobi::getCountriesList($params); CheckMobi::getPrefixes($params); CheckMobi::checkNumber($params); CheckMobi::validationStatus($validationId, $params); CheckMobi::sendSMS($params); CheckMobi::getSmsDetails($params); CheckMobi::placeCall($params); CheckMobi::getCallDetails($callId, $params); CheckMobi::hangUpCall($callId, $params); MissedCall::request($params); MissedCall::verify($params);
API Usage Example
MissedCall
use Myckhel\CheckMobi\Support\MissedCall; use CheckMobi; class VerificationController { public function request(){ return MissedCall::request([ 'number' => '+1 234 567 890', // E. 164 format 'platform' => 'web', ]); } public function verify(){ return MissedCall::verify([ 'id' => 'SMS-FF9137C1-4D39-42B0-BE86-4B5A96CE13BD', // E. 164 format 'pin' => '9711', ]); } public function exampleCheckMobi(){ $validationResponse = CheckMobi::requestValidation([ 'number' => '+1 234 567 890', // E. 164 format 'type' => 'reverse_cli', 'platform' => 'web', ]); $verificationResponse = CheckMobi::verifyValidation([ "id": "SMS-FF9137C1-4D39-42B0-BE86-4B5A96CE13BD", // $validationResponse->id "pin":"9711" ]); } }
Response Example
Request
{ "id": "RCL-B772A954-7E63-4114-8087-BAF415B5003F", "type": "reverse_cli", "pin_hash": "6f8246002c1c5967ffc5e0ec80f2d7b59a60b1e3", "validation_info": { "country_code": 40, "country_iso_code": "RO", "carrier": "Orange", "is_mobile": true, "e164_format": "+40743XXXXXX", "formatting": "+40 743 XXX XXX" } }
Verify
{ "number":"+40XXXXXXXXX", "validated":true, "validation_date":1416946931, "charged_amount": 0.1 }
Todos
- coming soon
Testing
Run the tests with:
vendor/bin/phpunit
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
Security
If you discover any security-related issues, please email myckhel1@hotmail.com instead of using the issue tracker.
License
The MIT License (MIT). Please see License File for more information.