Overview

Namespaces

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

Classes

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

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( mixed $data )

Parameters

$data
mixed
$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 mixed
# setTo( mixed $to )

Set mobile phone number of the recipients.

Set mobile phone number of the recipients.

Parameters

$to
mixed
$to array|string phone number

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

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

$idx
string|array
$idx

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

$check
boolean
$check

Returns

mixed
$this
public mixed
# setPartner( string $partner )

Set affiliate code.

Set affiliate code.

Parameters

$partner
string
$partner affiliate code

Returns

mixed
$this
public mixed
# setFile( mixed $file )

Set local audio filename.

Set local audio filename.

Parameters

$file
mixed
$file

Returns

mixed
$this
public mixed
# setTts( string $tts )

Set text to voice synthesizer.

Set text to voice synthesizer.

Parameters

$tts
string
$tts text to read

Returns

mixed
$this
public mixed
# setSkipGsm( mixed $skipGsm )

Set flag to not send messages on cell phone numbers.

Set flag to not send messages on cell phone numbers.

Parameters

$skipGsm
mixed
$skipGsm

Returns

mixed
$this
public mixed
# setTtsLector( string $lector )

Set lector name.

Set lector name.

Parameters

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

Returns

mixed
$this
public mixed
# setFrom( mixed $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
mixed
$from

Returns

mixed
$this
public mixed
# setTry( integer $try )

Set number of connection attempts.

Set number of connection attempts.

Parameters

$try
integer
$try Number of connection attempts

Returns

mixed
$this

Throws

OutOfRangeException
public mixed
# 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
integer
$interval Time in seconds

Returns

mixed
$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
API documentation generated by ApiGen 2.8.0