\OctopushApi

The API to push sms message, get response, credit and balance

Summary

Methods
Properties
Constants
__construct()
getResponse()
getClient()
getCredit()
getBalance()
getPremiumBalance()
getLowCostBalance()
sendMessage()
No public properties found
No constants found
No protected methods found
$client
N/A
No private methods found
No private properties found
N/A

Properties

Methods

__construct()

__construct(string  $login, string  $key) : void

Create a new API service

Parameters

string $login

The Octopush login key

string $key

The Octopush API key available on your Octopush manager.

getResponse()

getResponse() : array

Returns the client response

Returns

array —

The client response php array

getClient()

getClient() : \Octopush\Client

Returns the api client

Returns

\Octopush\Client

getCredit()

getCredit() : float

Retourne le solde sms en Euros.

Returns

float

getBalance()

getBalance() : array

Returns the array remaining balance with premium and low cost value

Returns

array —

The balance array

getPremiumBalance()

getPremiumBalance() : integer

Returns the remaining balance in premium

Returns

integer —

the value in sms

getLowCostBalance()

getLowCostBalance() : integer

Returns the remaining balance in low cost

Returns

integer —

the value in sms

sendMessage()

sendMessage(string  $message, array  $options = array()) : boolean

Send a sms message

Parameters

string $message

The string message

array $options

The array options

Returns

boolean —

true if message is send otherwise false