siapepfrance/free-mobile-sms-php-client

0.1.0 2021-10-28 15:47 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

This is a Swagger generated doc for Free Mobile REST API 1. You can find additionnal documentation here : Online documentation.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, execute the following command :

composer require siapepfrance/free-mobile-sms-php-client

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/free-mobile-sms-php-client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new \SiapepFrance\FreeMobile\Sms\Api\SmsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$user = "user_example"; // string | User of free mobile account
$pass = "pass_example"; // string | Password of free mobile account
$msg = "msg_example"; // string | Message to send (max length 999 caracters, above it will trigger 400 error)

try {
    $apiInstance->sendmsgPost($user, $pass, $msg);
} catch (Exception $e) {
    echo 'Exception when calling SmsApi->sendmsgPost: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://smsapi.free-mobile.fr/

Class	Method	HTTP request	Description
SmsApi	sendmsgPost	POST /sendmsg	Send a SMS to a user

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]