REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiMtBatchSms

Base class for all SMS batch classes.

Holds fields that are common to both the create and response classes.

Summary

Methods
Properties
Constants
getRecipients()
setRecipients()
getSender()
setSender()
getDeliveryReport()
setDeliveryReport()
getSendAt()
setSendAt()
getExpireAt()
setExpireAt()
getCallbackUrl()
setCallbackUrl()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getRecipients()

getRecipients() : array<mixed,string>

Get the batch recipients.

Returns

array<mixed,string> —

one or more MSISDNs

setRecipients()

setRecipients(array<mixed,string>  $recipients) : void

Set the batch recipients.

Parameters

array<mixed,string> $recipients

one or more MSISDNs

getSender()

getSender() : string

Get the batch sender.

Returns

string —

a short code or long number

setSender()

setSender(string  $sender) : void

Set the batch sender.

Parameters

string $sender

a short code or long number

getDeliveryReport()

getDeliveryReport() : \Clx\Xms\Api\ReportType

Get the type of delivery report to use for this batch.

Returns

\Clx\Xms\Api\ReportType —

the report type

setDeliveryReport()

setDeliveryReport(\Clx\Xms\Api\ReportType  $deliveryReport) : void

Set the type of delivery report to use for this batch.

Parameters

\Clx\Xms\Api\ReportType $deliveryReport

the report type

getSendAt()

getSendAt() : \DateTime

Get the time at which this batch should be sent.

Returns

\DateTime —

the send date and time

setSendAt()

setSendAt(\DateTime  $sendAt) : void

Set the time at which this batch should be sent.

Parameters

\DateTime $sendAt

the send date and time

getExpireAt()

getExpireAt() : \DateTime

Get the time at which this batch should expire.

Returns

\DateTime —

the expiry date and time

setExpireAt()

setExpireAt(\DateTime  $expireAt) : void

Set the time at which this batch should expire.

Parameters

\DateTime $expireAt

the expiry date and time

getCallbackUrl()

getCallbackUrl() : string

Get the URL to which callbacks should be sent.

Returns

string —

a valid URL

setCallbackUrl()

setCallbackUrl(string  $callbackUrl) : void

Set the URL to which callbacks should be sent.

Parameters

string $callbackUrl

a valid URL