\Clx\Xms\ApiMtBatchTextSmsUpdate

getRecipientInsertions()

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

Get the message destinations to add to the batch.

Returns

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

getRecipientRemovals()

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

Get the message destinations to remove from the batch.

Returns

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

getSender()

getSender() : string|null

Get the message originator.

If null then the batch sender will remain unchanged.

Returns

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

getDeliveryReport()

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

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

Returns

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

getSendAt()

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

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

Returns

an update description

resetSendAt()

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

Resets the send at field to the XMS default value.

Returns

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

getExpireAt()

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

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

Returns

an update description

resetExpireAt()

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

Resets the expire at field to the XMS default value.

Returns

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

getCallbackUrl()

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

Get description of how to update the batch callback URL.

Returns

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

getBody()

getBody() : string|null

Get the updated batch message body or template.

Returns

the batch message body

setBody()

setBody(string|null  $body) : void

Set the updated batch message body or template.

Parameters

getParameters()

getParameters() : array<mixed,>|null|\Clx\Xms\Api\Reset

Get description of how to update the batch parameters.

If null then the parameters are kept as is, if Reset::reset() then the value is reset to XMS default, otherwise update the parameters.

Returns

an update description

resetParameters()

resetParameters() : void

Resets the parameters field to the XMS default value.

setParameters()

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

Set description of how to update the batch parameters.

If null then the parameters are kept as is, otherwise update the parameters.

Parameters