REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiMtBatchTextSmsResult

A textual batch as returned by the XMS endpoint.

This differs from the batch creation definition by the addition of, for example, the batch identifier and the creation time.

Summary

Methods
Properties
Constants
getBatchId()
setBatchId()
getCreatedAt()
setCreatedAt()
getModifiedAt()
setModifiedAt()
isCanceled()
setCanceled()
getRecipients()
setRecipients()
getSender()
setSender()
getDeliveryReport()
setDeliveryReport()
getSendAt()
setSendAt()
getExpireAt()
setExpireAt()
getCallbackUrl()
setCallbackUrl()
getBody()
setBody()
getParameters()
setParameters()
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

getBatchId()

getBatchId() : string

Get the unique batch identifier.

Returns

string —

batch identifier

setBatchId()

setBatchId(string  $batchId) : void

Set the unique batch identifier.

Parameters

string $batchId

batch identifier

getCreatedAt()

getCreatedAt() : \DateTime

Get the time when this batch was created.

Returns

\DateTime —

time when this batch was created

setCreatedAt()

setCreatedAt(\DateTime  $createdAt) : void

Set the time when this batch was created.

Parameters

\DateTime $createdAt

time when this batch was created

getModifiedAt()

getModifiedAt() : \DateTime

Get the time when this batch was last modified.

Returns

\DateTime —

time at last modification

setModifiedAt()

setModifiedAt(\DateTime  $modifiedAt) : void

Set the time when this batch was last modified.

Parameters

\DateTime $modifiedAt

time at last modification

isCanceled()

isCanceled() : boolean

Whether this batch has been canceled.

Returns

boolean —

true if canceled, false otherwise

setCanceled()

setCanceled(boolean  $canceled) : void

Set this batch cancellation status.

Parameters

boolean $canceled

true if canceled, false otherwise

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

getBody()

getBody() : string

Get the message body or template.

Returns

string —

the textual batch message

setBody()

setBody(string  $body) : void

Set the message body or template.

Parameters

string $body

the textual batch message

getParameters()

getParameters() : array<mixed,>

Get the template parameters.

Returns

array<mixed,> —

the template parameter definition

setParameters()

setParameters(array<mixed,>  $parameters) : void

Set the template parameters.

Parameters

array<mixed,> $parameters

the template parameter definition