Overview

Namespaces

  • SMSApi
    • Api
      • Action
        • Phonebook
        • Sender
        • Sms
        • User
      • Response
    • Exception
    • Proxy
      • Http

Classes

  • Delete
  • Get
  • Send
  • Overview
  • Namespace
  • Class

Class Send

Class Send

SMSApi\Api\Action\AbstractAction
Extended by SMSApi\Api\Action\Sms\Send
Namespace: SMSApi\Api\Action\Sms
Package: SMSApi\Api\Action\Sms
Located at Api/Action/Sms/Send.php
Methods summary
protected SMSApi\Api\Response\StatusResponse
# response( $data )

Parameters

$data

Returns

SMSApi\Api\Response\StatusResponse
public SMSApi\Proxy\Uri
# uri( )

Returns

SMSApi\Proxy\Uri

Throws

SMSApi\Exception\ActionException
public
# setText( $text )

Set SMS text message.

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

$text

Returns


$this
public
# 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

Returns


$this
public
# setTo( string|array|integer $to )

Set mobile phone number of the recipients.

Set mobile phone number of the recipients.

Parameters

$to
Phone number recipient/s.

Returns


$this
public
# 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 name

Returns


$this
public
# 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
set timestamp or ISO 8601 date format

Returns


$this
public
# 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

$idx

Returns


$this
public
# 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

$check

Returns


$this
public
# setPartner( string $partner )

Set affiliate code.

Set affiliate code.

Parameters

$partner
affiliate code

Returns


$this
public
# 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
in timestamp

Returns


$this
public
# setSender( string $sender )

Set name of the 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
sender name or eco or 2way

Returns


$this
public
# 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

$single

Returns


$this
public
# setNoUnicode( boolean $noUnicode )

Set protection from sending messages containing special characters.

Set protection from sending messages containing special characters.

Parameters

$noUnicode
if true turn on protection

Returns


$this
public
# 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

Returns


$this
public
# 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

$flash

Returns


$this
public
# setNormalize( boolean $normalize )

Set normalize SMS text.

Set normalize SMS text.

Removing dialectic characters from message.

Parameters

$normalize

Returns


$this
public
# 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
if true set higher priority otherwise normal priority

Returns


$this
public
# SetParam( integer $i, string|string[] $text )

Set personalized parameters to bulk messages.

Set personalized parameters to bulk messages.

Parameters

$i
$text

Returns


$this

Throws

OutOfRangeException
public
# setTemplate( $name )

Set template

Set template

Parameters

$name

Returns


$this
Methods inherited from SMSApi\Api\Action\AbstractAction
__construct(), client(), execute(), file(), handleError(), paramsBasicToQuery(), paramsLoginToQuery(), paramsOther(), proxy(), renderTo(), setJson(), setTest()
Magic methods summary
public SMSApi\Api\Response\StatusResponse
# execute( )

Returns

SMSApi\Api\Response\StatusResponse
Properties summary
protected string $encoding
# 'utf-8'
Properties inherited from SMSApi\Api\Action\AbstractAction
$client, $date, $group, $idx, $params, $proxy, $to
SMSAPI Api Client API documentation generated by ApiGen