LDAP Account Manager

GatewayApiSmsProvider
in package
implements SmsProvider

GatewayAPI SMS provider.

Interfaces, Classes, Traits and Enums

SmsProvider
Interface for providers of SMS services.

Table of Contents

getId()  : string
Returns the id of the service
getLabel()  : string
Returns the label of the service
sendSms()  : void
Sends out an SMS.
usesAccountId()  : bool
Returns if the provider requires an account ID.
usesApiKey()  : bool
Returns if the provider requires an API key.
usesApiToken()  : bool
Returns if the provider requires a token.
usesFrom()  : bool
Returns if the provider requires a FROM field.
usesRegion()  : bool
Returns if the provider requires a region field.

Methods

getId()

Returns the id of the service

public getId() : string
Tags
inheritDoc
Return values
string —

id

getLabel()

Returns the label of the service

public getLabel() : string
Tags
inheritDoc
Return values
string —

label

sendSms()

Sends out an SMS.

public sendSms(string $message, string $number[, string|null $apiKey = '' ][, string|null $apiToken = '' ][, string|null $accountId = '' ][, string|null $region = '' ][, string|null $from = '' ]) : void
Parameters
$message : string

message text

$number : string

mobile phone number

$apiKey : string|null = ''

API key

$apiToken : string|null = ''

API token

$accountId : string|null = ''

account ID

$region : string|null = ''
$from : string|null = ''

from

Tags
inheritDoc
Return values
void —

usesAccountId()

Returns if the provider requires an account ID.

public usesAccountId() : bool
Tags
inheritDoc
Return values
bool —

account id required

usesApiKey()

Returns if the provider requires an API key.

public usesApiKey() : bool
Tags
inheritDoc
Return values
bool —

key required

usesApiToken()

Returns if the provider requires a token.

public usesApiToken() : bool
Tags
inheritDoc
Return values
bool —

token required

usesFrom()

Returns if the provider requires a FROM field.

public usesFrom() : bool
Tags
inheritDoc
Return values
bool —

key required

usesRegion()

Returns if the provider requires a region field.

public usesRegion() : bool
Tags
inheritDoc
Return values
bool —

region required

Search results