Methods summary
protected
SMSApi\Api\Response\StatusResponse
|
|
public
SMSApi\Proxy\Uri
|
|
public
mixed
|
#
setText( mixed $text )
Set SMS text message.
Content of one message is normally 160 characters per single SMS or 70 in
case of using at least one special character
Parameters
Returns
mixed $this
|
public
mixed
|
#
setEncoding( string $encoding )
Set the SMS encoding charset, default is UTF-8.
Set the SMS encoding charset, default is UTF-8.
Example: windows-1250 iso-8859-2
Parameters
- $encoding
string $encoding
Returns
mixed $this
|
public
mixed
|
#
setTo( string|array|integer $to )
Set mobile phone number of the recipients.
Set mobile phone number of the recipients.
Parameters
- $to
string|array|integer $to Phone number recipient/s.
Returns
mixed $this
|
public
mixed
|
#
setGroup( string $group )
Set name of the group from the phone book to which message should be
sent.
Set name of the group from the phone book to which message should be
sent.
Parameters
- $group
string $group String group name
Returns
mixed $this
|
public
mixed
|
#
setDateSent( mixed $date )
Set scheduled date sending message.
Set scheduled date sending message.
Setting a past date will result in sending message instantly.
Parameters
- $date
mixed $date set timestamp or ISO 8601 date format
Returns
mixed $this
|
public
mixed
|
#
setIDx( string|array $idx )
Set optional custom value sent with SMS and sent back in CALLBACK.
Set optional custom value sent with SMS and sent back in CALLBACK.
Parameters
Returns
mixed $this
|
public
mixed
|
#
setCheckIDx( boolean $check )
Set checking idx is unique.
Set checking idx is unique.
Prevents from sending more than one message with the same idx. When this
parameter is set and message with the same idx was already sent error 53 is
returned.
Parameters
Returns
mixed $this
|
public
mixed
|
#
setPartner( string $partner )
Set affiliate code.
Parameters
- $partner
string $partner affiliate code
Returns
mixed $this
|
public
mixed
|
#
setDateExpire( integer $date )
Set expiration date.
Message expiration date (in unix timestamp) is a date after which message
won't be delivered if it wasn't delivered yet. The difference between date sent
and expiration date can't be less than 1 hour and more than 12 hours. Time will
be set with tolerance +/- 5 minutes.
Parameters
- $date
integer $date in timestamp
Returns
mixed $this
|
public
mixed
|
#
setSender( string $sender )
Set name of the sender.
To send SMS as ECO use sender name ECO . To send SMS as 2Way use
sender name 2Way .
Only verified names are being accepted.
Parameters
- $sender
string $sender sender name or eco or 2way
Returns
mixed $this
|
public
mixed
|
#
setSingle( boolean $single )
Set protection from send multipart messages.
Set protection from send multipart messages.
If the message will contain more than 160 chars (single message) it won't be
sent and return error
Parameters
Returns
mixed $this
|
public
mixed
|
#
setNoUnicode( boolean $noUnicode )
Set protection from sending messages containing special characters.
Set protection from sending messages containing special characters.
Parameters
- $noUnicode
boolean $noUnicode if true turn on protection
Returns
mixed $this
|
public
mixed
|
#
setDataCoding( string $dataCoding )
Set SMS message data coding.
Set SMS message data coding.
This parameter allows to send WAP PUSH messages.
Example: bin
Parameters
- $dataCoding
string $dataCoding
Returns
mixed $this
|
public
mixed
|
#
setFlash( boolean $flash )
Set SMS message in flash mode.
Set SMS message in flash mode.
Flash SMS are automatically presented on the mobile screen and have to be
saved to be default stored in inbox.
Parameters
Returns
mixed $this
|
public
mixed
|
#
setNormalize( boolean $normalize )
Set normalize SMS text.
Removing dialectic characters from message.
Parameters
- $normalize
boolean $normalize
Returns
mixed $this
|
public
mixed
|
#
setFast( boolean $fast )
Set higher priority of sending message. Prohibited for bulk messages.
Set higher priority of sending message. Prohibited for bulk messages.
Parameters
- $fast
boolean $fast if true set higher priority otherwise normal priority
Returns
mixed $this
|
public
mixed
|
#
SetParam( integer $i, string|string[] $text )
Set personalized parameters to bulk messages.
Set personalized parameters to bulk messages.
Parameters
- $i
integer $i
- $text
string|string[] $text
Returns
mixed $this
Throws
|
public
mixed
|
#
setTemplate( mixed $name )
Set template
Parameters
Returns
mixed $this
|