Resource Description for SmsMessage

Properties for SmsMessage

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
actionRequiredByDatetime DateTime
creditsUsed float
draftRecipient MessageDraftRecipient
failedDatetime DateTime
free bool
messageParts int
messageText string
messageType string
readDatetime DateTime
receivedDatetime DateTime
recipient mixed
recipientNetworkCode string
recipientNumber string
sender mixed
senderNumber string
sentDatetime DateTime
smsMessageDraft SmsMessageDraft
totalCost string

SDK Example for PHP

<?PHP

use Arbor\Api\Gateway\RestGateway;
use Arbor\Model\ModelBase;
use Arbor\Model\SmsMessage;

ModelBase::setDefaultGateway(
    new RestGateway(
        "https://my-school.arbor.sc/rest-v2",
        "my.username@my-school.arbor.sc",
        "3bh54435v3gh45"
    )
);

$smsMessage = SmsMessage::retrieve(5433);

$smsMessageDraft = $smsMessage->getSmsMessageDraft();
$messageType = $smsMessage->getMessageType();
$senderNumber = $smsMessage->getSenderNumber();
$sender = $smsMessage->getSender();
$recipientNumber = $smsMessage->getRecipientNumber();
$recipient = $smsMessage->getRecipient();
$draftRecipient = $smsMessage->getDraftRecipient();
$sentDatetime = $smsMessage->getSentDatetime();
$readDatetime = $smsMessage->getReadDatetime();
$receivedDatetime = $smsMessage->getReceivedDatetime();
$failedDatetime = $smsMessage->getFailedDatetime();
$totalCost = $smsMessage->getTotalCost();
$messageParts = $smsMessage->getMessageParts();
$recipientNetworkCode = $smsMessage->getRecipientNetworkCode();
$actionRequiredByDatetime = $smsMessage->getActionRequiredByDatetime();

 

Related Resources