mocean/client7

PHP Client for using Mocean's API.

2.1.2 2021-08-04 10:28 UTC

This package is auto-updated.

Last update: 2022-07-10 05:49:27 UTC


README

Latest Stable Version build codecov codacy StyleCI License Total Downloads

This library requires a minimum PHP version of 5.5

This is the PHP client library for use Mocean's API. To use this, you'll need a Mocean account. Sign up for free at moceanapi.com.

Installation

To use the client library you'll need to have created a Mocean account.

To install the PHP client library using Composer.

composer require mocean/client7

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 client with your API key and secret:

use Mocean\Client;
use Mocean\Client\Credentials\Basic;

$mocean = new Client(new Basic('API_KEY_HERE','API_SECRET_HERE'));

Example

To use Mocean's SMS API to send an SMS message, call the $mocean->message()->send(); method.

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

$res = $mocean->message()->send([
    'mocean-to' => '60123456789',
    'mocean-from' => 'MOCEAN',
    'mocean-text' => 'Hello World'
]);

echo $res;

Responses

For your convenient, the API response data can be accessed either using php object style or array style

echo $res;            //show full response string
echo $res['status'];  //show response status, '0' in this case
echo $res->status;    //same as above

Documentation

Kindly visit MoceanApi Docs for more usage

License

This library is released under the MIT License