Overview

Namespaces

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

Classes

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

Class Send

Class Send

SMSApi\Api\Action\AbstractAction
Extended by SMSApi\Api\Action\Vms\Send
Namespace: SMSApi\Api\Action\Vms
Package: SMSApi\Api\Action\Vms
Located at Api/Action/Vms/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 mixed
# file( )

Returns

mixed

Overrides

SMSApi\Api\Action\AbstractAction::file()
public
# setTo( $to )

Set mobile phone number of the recipients.

Set mobile phone number of the recipients.

Parameters

$to
phone number

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
group name

Returns


$this
public
# setDateSent( $date )

Set scheduled date sending message.

Set scheduled date sending message.

Setting a past date will result in sending message instantly.

Parameters

$date

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
# setFile( $file )

Set local audio filename.

Set local audio filename.

Parameters

$file

Returns


$this
public
# setTts( string $tts )

Set text to voice synthesizer.

Set text to voice synthesizer.

Parameters

$tts
text to read

Returns


$this
public
# setSkipGsm( $skipGsm )

Set flag to not send messages on cell phone numbers.

Set flag to not send messages on cell phone numbers.

Parameters

$skipGsm

Returns


$this
public
# setTtsLector( string $lector )

Set lector name.

Set lector name.

Parameters

$lector
The value of $lector can be: agnieszka, ewa, jacek, jan or maja

Returns


$this
public
# setFrom( $from )

Set called number. Leaving the field blank causes the sending of the default number of callers.

Set called number. Leaving the field blank causes the sending of the default number of callers.

Parameters

$from

Returns


$this
public
# setTry( integer $try )

Set number of connection attempts.

Set number of connection attempts.

Parameters

$try
Number of connection attempts

Returns


$this

Throws

OutOfRangeException
public
# setInterval( integer $interval )

Set the time in seconds where the connection have to be repeated in the case of not answer by receiver or reject this connection.

Set the time in seconds where the connection have to be repeated in the case of not answer by receiver or reject this connection.

Parameters

$interval
Time in seconds

Returns


$this

Throws

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

Returns

SMSApi\Api\Response\StatusResponse
Constants summary
string LECTOR_AGNIESZKA
# "agnieszka"
string LECTOR_EWA
# "ewa"
string LECTOR_JACEK
# "jacek"
string LECTOR_JAN
# "jan"
string LECTOR_MAJA
# "maja"
Properties inherited from SMSApi\Api\Action\AbstractAction
$client, $date, $encoding, $group, $idx, $params, $proxy, $to
SMSAPI Api Client API documentation generated by ApiGen