Class dosamigos\nexmo\DeliveryReceipt

Inheritancedosamigos\nexmo\DeliveryReceipt » dosamigos\nexmo\Object » yii\base\Object
Class DeliveryReceipt is the class that holds all the parameters received when a CallBack Url is set for message delivery callback. Nexmo calls your configured CallBack Url (that should be done using dosamigos\nexmo\DeliveryCallbackAction action) and sends a list of parameters that dosamigos\nexmo\DeliveryReceipt is initialized with.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$clientRef string If you set a custom reference during your send request, this will return that value. dosamigos\nexmo\DeliveryReceipt
$errCode string The status related error code dosamigos\nexmo\DeliveryReceipt
$messageId string The message ID. dosamigos\nexmo\Object
$messageTimestamp string When Nexmo started to push the receipt to your callback URL in the following format YYYY-MM-DD HH:MM:SS e. dosamigos\nexmo\Object
$msisdn string The number message was delivered to. dosamigos\nexmo\Object
$networkCode string The optional identifier of a mobile network MCCMNC. dosamigos\nexmo\Object
$price string The message price dosamigos\nexmo\DeliveryReceipt
$scts string UTC time when notification is received from mobile network in the following format YYMMDDHHMM e. dosamigos\nexmo\DeliveryReceipt
$status string The status of the message dosamigos\nexmo\DeliveryReceipt
$to string The sender id of the message dosamigos\nexmo\Object

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Constructor override. Required to transform the parameter names to variable names. dosamigos\nexmo\Object
getErrorLabel() dosamigos\nexmo\DeliveryReceipt
getReceivedTime() Returns the time in milliseconds from $scts dosamigos\nexmo\DeliveryReceipt
init() dosamigos\nexmo\DeliveryReceipt
registerTranslations() Registers the translations dosamigos\nexmo\DeliveryReceipt

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
STATUS_ACCEPTED 'accepted' Message has been accepted by the mobile operator. dosamigos\nexmo\DeliveryReceipt
STATUS_BUFFERED 'buffered' Message is being delivered. dosamigos\nexmo\DeliveryReceipt
STATUS_DELIVERED 'delivered' Message arrived to handset. dosamigos\nexmo\DeliveryReceipt
STATUS_EXPIRED 'expired' Message timed out after we waited 48h to receive status from mobile operator. dosamigos\nexmo\DeliveryReceipt
STATUS_FAILED 'failed' Message failed to be delivered. dosamigos\nexmo\DeliveryReceipt
STATUS_UNKNOWN 'unknown' Undocumented status from the mobile operator. dosamigos\nexmo\DeliveryReceipt

Property Details

$clientRef public property

If you set a custom reference during your send request, this will return that value.

$errCode public property

The status related error code

$price public property
string $price null

The message price

$scts public property
string $scts null

UTC time when notification is received from mobile network in the following format YYMMDDHHMM e.g. 1101181426 is 2011 Jan 18th 14:26

$status public property
string $status null

The status of the message

Method Details

getErrorLabel() public method

string|null getErrorLabel( )
return string|null

The error label

getReceivedTime() public method

Returns the time in milliseconds from $scts

int getReceivedTime( )
return int

The received time

init() public method

void init( )
registerTranslations() public method

Registers the translations

void registerTranslations( )