\Clx\Xms\ApiMtBatchTextSmsCreate

getTags()

getTags() : array<mixed,string>

Get the initial set of tags to give the batch.

Returns

batch tags

setTags()

setTags(array<mixed,string>  $tags) : void

Set the initial set of tags to give the batch.

Parameters

getRecipients()

getRecipients() : array<mixed,string>

Get the batch recipients.

Returns

one or more MSISDNs

setRecipients()

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

Set the batch recipients.

Parameters

getSender()

getSender() : string

Get the batch sender.

Returns

a short code or long number

setSender()

setSender(string  $sender) : void

Set the batch sender.

Parameters

getDeliveryReport()

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

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

Returns

the report type

setDeliveryReport()

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

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

Parameters

getSendAt()

getSendAt() : \DateTime

Get the time at which this batch should be sent.

Returns

the send date and time

setSendAt()

setSendAt(\DateTime  $sendAt) : void

Set the time at which this batch should be sent.

Parameters

getExpireAt()

getExpireAt() : \DateTime

Get the time at which this batch should expire.

Returns

the expiry date and time

setExpireAt()

setExpireAt(\DateTime  $expireAt) : void

Set the time at which this batch should expire.

Parameters

getCallbackUrl()

getCallbackUrl() : string

Get the URL to which callbacks should be sent.

Returns

a valid URL

setCallbackUrl()

setCallbackUrl(string  $callbackUrl) : void

Set the URL to which callbacks should be sent.

Parameters

getBody()

getBody() : string

Get the message body or template.

Returns

the textual batch message

setBody()

setBody(string  $body) : void

Set the message body or template.

Parameters

getParameters()

getParameters() : array<mixed,>

Get the template parameters.

Returns

template parameters

setParameters()

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

Set the template parameters.

This property is only relevant if the message body is a template. This is expected to be an associative array mapping parameter keys to associative arrays themselves mapping recipient numbers to substitution strings.

More concretely we may have for the parameterized message "Hello, ${name}!" have

$parameters = [
    'name' => [
        '123456789' => 'Mary',
        '987654321' => 'Joe',
        'default' => 'valued customer'
    ]
];

And the recipient with MSISDN "123456789" would then receive the message "Hello, Mary!".

Note the use of "default" to indicate the substitution for recipients not explicitly given. For example, the recipient "555555555" would receive the message "Hello, valued customer!".

Parameters