rungopher/simplesms

This library provides an easy way to interact with the Rungopher SimpleSms API

Rungopher SimpleSMS PHP Library

, _(*1)

This library provides an easy way to interact with the Rungopher SimpleSms API., _(*2)

Installation

Distributed via packagist. The suggested installation method is via composer:, _(*3)

``` shell composer require "rungopher/simplesms:~1.0.0", <sub>(*4)</sub>

## Usage
### Sending an SMS:

*Note: This example uses cURL which requires the [cURL PHP Extension](http://php.net/manual/en/book.curl.php). To use a custom requester see* ***Using a Custom Requester*** *below.*

``` php
use Rungopher\SimpleSms\CurlRequester;
use Rungopher\SimpleSms\SimpleSmsClient;

$requester = new CurlRequester();
$client = new SimpleSmsClient($requester, "username", "password", "from");

try {
    $response = $client->sendSms("to", "message");
} catch(SimpleSmsErrorException $e) {
    log($e->getMessage());
}

Error: SimpleSmsErrorException is thrown containing the error message., <sub>(*5)</sub>

Success: $client->sendSms() returns an instance of SimpleSmsOutbound which has the following methods:, <sub>(*6)</sub>

Receiving a Delivery Receipt:

``` php use Rungopher\SimpleSms\Messages\SimpleSmsDeliveryReceipt;, <sub>(*7)</sub>

$deliveryReceipt = SimpleSmsDeliveryReceipt::fromRequestBody($requestBody);, <sub>(*8)</sub>

**SimpleSmsDeliveryReceipt:**

| Method          | Response Field |
| --------------- | -------------- |
| getMessageSid() | MessageSid     |
| getStatus()     | Status         |
| wasDelivered()  | NA             |
| failed()        | NA             |


### Receiving an Inbound SMS:
``` php
use Rungopher\SimpleSms\Messages\SimpleSmsInbound;

$inboundSms = SimpleSmsInbound::fromRequestBody($requestBody);

SimpleSmsInbound:, <sub>(*9)</sub>

Using a Custom Requester

A custom requester must implement RequesterInterface:, <sub>(*10)</sub>

``` php /** returns: SimpleSmsResponse */ public function newRequest(SimpleSmsRequest $request);, <sub>(*11)</sub>

**SimpleSmsRequest:**

| Method          | Returns               |
| --------------- | --------------------- |
| getBody()       | The request body.     |
| getUrl()        | The request url.      |
| getPort()       | The request port.     |
| getUsername()   | The request username. |
| getPassword()   | The request password. |


**SimpleSmsResponse:**

| Property          | Description                   |
| ----------------- | ----------------------------- |
| statusCode        | The request http status code. |
| response          | The request response body.    |

``` php
return new SimpleSmsResponse($statusCode, $response);