Aculab Web Services Wrapper (v1.0.5)
\
Aculab
WebServicesWrapper

\Aculab\WebServicesWrapperMessageStatus

SMS message status

Summary

Methods
Properties
Constants
getStatus()
getFailureCause()
getMultipartUid()
getMultipartPos()
getMultipartCount()
getTimestamp()
getAculabErrorMessage()
No public properties found
QUEUED
CANCELLED
SUBMITTED_TO_CARRIER
SENT
DELIVERED
ACCEPTED
FAILED
RECEIVED
UNKNOWN
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

QUEUED

QUEUED

The message is queued for sending.

CANCELLED

CANCELLED

The message has been cancelled using msg_cancel.

SUBMITTED_TO_CARRIER

SUBMITTED_TO_CARRIER

The message has been submitted to the carrier.

SENT

SENT

The message has been sent by the carrier.

DELIVERED

DELIVERED

The carrier has reported delivery to the phone with number "to".

Note that delivery is reported only if supported by the carrier and request_delivery_report was specified when calling msg_send.

ACCEPTED

ACCEPTED

The message has been read on behalf of the phone onwer by someone else.

Note that acceptance is reported only if supported by the carrier and request_delivery_report was specified when calling msg_send.

FAILED

FAILED

There was a problem sending the message. The textual reason from getFailureCause() explains why.

RECEIVED

RECEIVED

The message was received from the carrier.

UNKNOWN

UNKNOWN

The message reference passed was not recognised.

Methods

getStatus()

getStatus() : string

Get the status of the message part.

Returns

string —

One of the constants listed.

getFailureCause()

getFailureCause() : string

Get the failure cause.

Returns

string —

Returns the failure cause where available, otherwise an empty string.

getMultipartUid()

getMultipartUid() : string

Get the multipart message UID.

Get the ID for the overall message, shared by all its parts, which is unique among all recent messages in this direction.

Returns

string

getMultipartPos()

getMultipartPos() : integer

Get the position of this message part in the overall message.

Gets the position of this message part within the overall message, 1...multipart_count.

Returns

integer

getMultipartCount()

getMultipartCount() : integer

Get the number of message parts in the overall message.

Gets the number of message parts within the overall message.

Returns

integer

getTimestamp()

getTimestamp() : \DateTime

Get when the status was last updated.

Returns

\DateTime

getAculabErrorMessage()

getAculabErrorMessage() : string

Get message status detail code.

Gets a numerical string representing more detailed information about the message status. Detailed information is only available on selected carriers, and will default to "001" if no further information available.

Returns

string