/AWS1/CL_PPTSMSCHANNELRESPONSE¶
Provides information about the status and settings of the SMS channel for an application.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_platform TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
Optional arguments:¶
iv_applicationid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The unique identifier for the application that the SMS channel applies to.
iv_creationdate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The date and time, in ISO 8601 format, when the SMS channel was enabled.
iv_enabled TYPE /AWS1/PPT__BOOLEAN /AWS1/PPT__BOOLEAN¶
Specifies whether the SMS channel is enabled for the application.
iv_hascredential TYPE /AWS1/PPT__BOOLEAN /AWS1/PPT__BOOLEAN¶
(Not used) This property is retained only for backward compatibility.
iv_id TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
iv_isarchived TYPE /AWS1/PPT__BOOLEAN /AWS1/PPT__BOOLEAN¶
Specifies whether the SMS channel is archived.
iv_lastmodifiedby TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The user who last modified the SMS channel.
iv_lastmodifieddate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The date and time, in ISO 8601 format, when the SMS channel was last modified.
iv_promotionalmessagespersec TYPE /AWS1/PPT__INTEGER /AWS1/PPT__INTEGER¶
The maximum number of promotional messages that you can send through the SMS channel each second.
iv_senderid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The identity that displays on recipients' devices when they receive messages from the SMS channel.
iv_shortcode TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The registered short code to use when you send messages through the SMS channel.
iv_transactionalmsgspersec TYPE /AWS1/PPT__INTEGER /AWS1/PPT__INTEGER¶
The maximum number of transactional messages that you can send through the SMS channel each second.
iv_version TYPE /AWS1/PPT__INTEGER /AWS1/PPT__INTEGER¶
The current version of the SMS channel.
Queryable Attributes¶
ApplicationId¶
The unique identifier for the application that the SMS channel applies to.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
CreationDate¶
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
Enabled¶
Specifies whether the SMS channel is enabled for the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLED() |
Getter for ENABLED, with configurable default |
ASK_ENABLED() |
Getter for ENABLED w/ exceptions if field has no value |
HAS_ENABLED() |
Determine if ENABLED has a value |
HasCredential¶
(Not used) This property is retained only for backward compatibility.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HASCREDENTIAL() |
Getter for HASCREDENTIAL, with configurable default |
ASK_HASCREDENTIAL() |
Getter for HASCREDENTIAL w/ exceptions if field has no value |
HAS_HASCREDENTIAL() |
Determine if HASCREDENTIAL has a value |
Id¶
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
IsArchived¶
Specifies whether the SMS channel is archived.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISARCHIVED() |
Getter for ISARCHIVED, with configurable default |
ASK_ISARCHIVED() |
Getter for ISARCHIVED w/ exceptions if field has no value |
HAS_ISARCHIVED() |
Determine if ISARCHIVED has a value |
LastModifiedBy¶
The user who last modified the SMS channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDBY() |
Getter for LASTMODIFIEDBY, with configurable default |
ASK_LASTMODIFIEDBY() |
Getter for LASTMODIFIEDBY w/ exceptions if field has no valu |
HAS_LASTMODIFIEDBY() |
Determine if LASTMODIFIEDBY has a value |
LastModifiedDate¶
The date and time, in ISO 8601 format, when the SMS channel was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
Platform¶
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLATFORM() |
Getter for PLATFORM, with configurable default |
ASK_PLATFORM() |
Getter for PLATFORM w/ exceptions if field has no value |
HAS_PLATFORM() |
Determine if PLATFORM has a value |
PromotionalMessagesPerSecond¶
The maximum number of promotional messages that you can send through the SMS channel each second.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROMOTIONALMSGSPERSEC() |
Getter for PROMOTIONALMESSAGESPERSECOND, with configurable d |
ASK_PROMOTIONALMSGSPERSEC() |
Getter for PROMOTIONALMESSAGESPERSECOND w/ exceptions if fie |
HAS_PROMOTIONALMSGSPERSEC() |
Determine if PROMOTIONALMESSAGESPERSECOND has a value |
SenderId¶
The identity that displays on recipients' devices when they receive messages from the SMS channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SENDERID() |
Getter for SENDERID, with configurable default |
ASK_SENDERID() |
Getter for SENDERID w/ exceptions if field has no value |
HAS_SENDERID() |
Determine if SENDERID has a value |
ShortCode¶
The registered short code to use when you send messages through the SMS channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHORTCODE() |
Getter for SHORTCODE, with configurable default |
ASK_SHORTCODE() |
Getter for SHORTCODE w/ exceptions if field has no value |
HAS_SHORTCODE() |
Determine if SHORTCODE has a value |
TransactionalMessagesPerSecond¶
The maximum number of transactional messages that you can send through the SMS channel each second.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRANSACTIONALMSGSPERSEC() |
Getter for TRANSACTIONALMESSAGESPERSEC, with configurable de |
ASK_TRANSACTIONALMSGSPERSEC() |
Getter for TRANSACTIONALMESSAGESPERSEC w/ exceptions if fiel |
HAS_TRANSACTIONALMSGSPERSEC() |
Determine if TRANSACTIONALMESSAGESPERSEC has a value |
Version¶
The current version of the SMS channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |