SMS Control
Xelion Object
↪ Entity
↪ SMS Control
An SMS control contains the contents, sender and recipients of an SMS, and is used to send an SMS to one or more recipients. Each recipient is defined by a Referable, which can be either an X1List or an Addressable.
The status determines how the SMS control is handled: a concept can still be edited, while a scheduled SMS control is sent straight away or on its send date. When the SMS control is sent, an {@link SMSMessage} is created for each individual recipient and linked to the SMS control, so the status of each message can be retrieved.
An SMS control with object type template is not sent, but can be used as the basis for other SMS controls.
Fields
| Name | Type | Notes | |
|---|---|---|---|
fromAddressee |
The sender of this SMS |
||
sendOnDate |
|
Date on which this SMS should be sent |
|
subject |
|
Subject line of the SMS (max 2000 characters) |
|
wantConfirmation |
|
Indicates whether delivery confirmation is requested |
|
toAddressees |
Recipients of this SMS, each defined by a Referable (X1List or Addressable) |
||
substitutionVars |
Substitution variables for message personalization |
||
messageText |
|
Message text content (max 2000 characters) |
|
status |
Status of this SMS: concept, scheduled, sent or failed |
||
smsObjectType |
Object type: control (sendable SMS) or template (basis for other SMS) |
||
basedOnTemplate |
SMS template on which this SMS is based (read-only) |
||
smsHttpReplyTo |
|
Optional 'reply-to' number for SMS sent via HTTP |
|
phoneLine |
Line from which the SMS was sent |