REST API SDK for SMS
\
Clx
Xms
Api

\Clx\Xms\ApiBatchDeliveryReport

A batch delivery report.

Summary

Methods
Properties
Constants
getBatchId()
setBatchId()
getTotalMessageCount()
setTotalMessageCount()
getStatuses()
setStatuses()
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 identifier of the batch that this report covers.

Returns

string —

batch identifier

setBatchId()

setBatchId(string  $batchId) : void

Set identifier of the batch that this report covers.

Parameters

string $batchId

batch identifier

getTotalMessageCount()

getTotalMessageCount() : integer

Get the total number of messages sent as part of this batch.

Returns

integer —

number of sent messages in the batch

setTotalMessageCount()

setTotalMessageCount(integer  $totalMessageCount) : void

Set the total number of messages sent as part of this batch.

Parameters

integer $totalMessageCount

number of sent messages in the batch

getStatuses()

getStatuses() : array<mixed,\Clx\Xms\Api\BatchDeliveryReportStatus>

Get the batch status buckets.

The returned array describes the aggregated status for the batch where each array element contains information about messages having a certain delivery status and delivery code.

Returns

array<mixed,\Clx\Xms\Api\BatchDeliveryReportStatus> —

status buckets

setStatuses()

setStatuses(array<mixed,\Clx\Xms\Api\BatchDeliveryReportStatus>  $statuses) : void

Set the batch status buckets.

The array describes the aggregated status for the batch where each array element contains information about messages having a certain delivery status and delivery code.

Parameters

array<mixed,\Clx\Xms\Api\BatchDeliveryReportStatus> $statuses

status buckets