REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiMtBatchSmsUpdate

Describes updates that can be performed on text and binary SMS batches.

Summary

Methods
Properties
Constants
getRecipientInsertions()
setRecipientInsertions()
getRecipientRemovals()
setRecipientRemovals()
getSender()
setSender()
getDeliveryReport()
resetDeliveryReport()
setDeliveryReport()
getSendAt()
resetSendAt()
setSendAt()
getExpireAt()
resetExpireAt()
setExpireAt()
getCallbackUrl()
resetCallbackUrl()
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

getRecipientInsertions()

getRecipientInsertions() : array<mixed,string>|null

Get the message destinations to add to the batch.

Returns

array<mixed,string>|null —

a list of MSISDNs or group IDs

setRecipientInsertions()

setRecipientInsertions(array<mixed,string>|null  $recipientInsertions) : void

Set the message destinations to add to the batch.

Parameters

array<mixed,string>|null $recipientInsertions

a list of MSISDNs or group IDs

getRecipientRemovals()

getRecipientRemovals() : array<mixed,string>|null

Get the message destinations to remove from the batch.

Returns

array<mixed,string>|null —

a list of MSISDNs or group IDs

setRecipientRemovals()

setRecipientRemovals(array<mixed,string>|null  $recipientRemovals) : void

Set the message destinations to remove from the batch.

Parameters

array<mixed,string>|null $recipientRemovals

a list of MSISDNs or group IDs

getSender()

getSender() : string|null

Get the message originator.

If null then the batch sender will remain unchanged.

Returns

string|null —

an MSISDN or short code

setSender()

setSender(string|null  $sender) : void

Set the message originator.

If null then the batch sender will remain unchanged.

Parameters

string|null $sender

an MSISDN or short code

getDeliveryReport()

getDeliveryReport() : string|null|\Clx\Xms\Api\Reset

Get description of how to update the batch delivery report value.

Returns

string|null|\Clx\Xms\Api\Reset —

an update description

resetDeliveryReport()

resetDeliveryReport() : void

Resets delivery report field to the XMS default value.

setDeliveryReport()

setDeliveryReport(string|null  $deliveryReport) : void

Set updated batch delivery report value.

If null then the current value is left unchanged.

Parameters

string|null $deliveryReport

an update description

getSendAt()

getSendAt() : \DateTime|null|\Clx\Xms\Api\Reset

Get description of how to update the batch send at value.

Returns

\DateTime|null|\Clx\Xms\Api\Reset —

an update description

resetSendAt()

resetSendAt() : \Clx\Xms\Api\MtBatchUpdate

Resets the send at field to the XMS default value.

Returns

\Clx\Xms\Api\MtBatchUpdate —

this object for use in a chained invocation

setSendAt()

setSendAt(\DateTime|null  $sendAt) : void

Set updated batch scheduled send at value.

If null then the current value is left unchanged.

Parameters

\DateTime|null $sendAt

scheduled send time

getExpireAt()

getExpireAt() : \DateTime|null|\Clx\Xms\Api\Reset

Get description of how to update the batch expire at value.

Returns

\DateTime|null|\Clx\Xms\Api\Reset —

an update description

resetExpireAt()

resetExpireAt() : \Clx\Xms\Api\MtBatchUpdate

Resets the expire at field to the XMS default value.

Returns

\Clx\Xms\Api\MtBatchUpdate —

this object for use in a chained invocation

setExpireAt()

setExpireAt(\DateTime|null  $expireAt) : void

Set updated batch expire at value.

If null then the current value is left unchanged.

Parameters

\DateTime|null $expireAt

expire at time

getCallbackUrl()

getCallbackUrl() : string|null|\Clx\Xms\Api\Reset

Get description of how to update the batch callback URL.

Returns

string|null|\Clx\Xms\Api\Reset —

an update description

resetCallbackUrl()

resetCallbackUrl() : void

Resets the callback URL to the XMS default value.

setCallbackUrl()

setCallbackUrl(string|null  $callbackUrl) : void

Set new batch callback URL.

If null then the current value is left unchanged.

Parameters

string|null $callbackUrl

updated callback URL