SMS Options
The following options allow for specification of SMS fields in generated SMS messages.
DEFAULT_DESTINATION_NPI
(integer, 0 - 255) By default, destination addresses will be assigned an NPI (Numeric Plan Indicator) value of zero. With this option, an alternate integer value in the range 0 to 255 may be assigned. Typical NPI values include those found in Table D–8 that follows:
Table D–8 Numeric Plan Indicator Values|
Value |
Description |
|---|---|
|
0 |
Unknown |
|
1 |
ISDN (E.163, E.164) |
|
3 |
Data (X.121) |
|
4 |
Telex (F.69) |
|
6 |
Land Mobile (E.212) |
|
8 |
National |
|
9 |
Private |
|
10 |
ERMES |
|
14 |
IP address (Internet) |
|
18 |
WAP client ID |
|
>= 19 |
Undefined |
Values for this option may be specified in one of three ways:
-
A decimal value (for example, 10).
-
A hexadecimal value prefixed by “0x” (for example, 0x0a).
-
One of the following case-insensitive text strings (the associated decimal value is shown in parentheses): data (3), default (0), e.163 (1), e.164 (1), e.212 (6), ermes (10), f.69 (4), Internet (14), ip (14), isdn (1), land-mobile (6), national (8), private (9), telex (4), unknown (0), wap (18), x.121 (3).
DEFAULT_DESTINATION_TON
(integer, 0 - 255) By default, destination addresses will be assigned a TON (Type of Number) designator value of zero. With this option, an alternate integer value in the range 0 to 255 may be assigned. Typical TON values include those found in Table D–9 that follows:
Table D–9 Typical TON Values|
Value |
Description |
|---|---|
|
0 |
Unknown |
|
1 |
International |
|
2 |
National |
|
3 |
Network specific |
|
4 |
Subscriber number |
|
5 |
Alphanumeric |
|
6 |
Abbreviated |
|
>=7 |
Undefined |
Values for this option may be specified in one of three ways:
-
A decimal value (for example, 10)
-
A hexadecimal value prefixed by “0x” (for example, 0x0a)
-
One of the following case-insensitive text strings (the associated decimal value is shown in parentheses): abbreviated (6), alphanumeric (5), default (0), international (1), national (2), network-specific (3), subscriber (4), unknown (0).
DEFAULT_PRIORITY
(integer, 0 - 255) SMS messages have a mandatory priority field. The interpretation of SMS priority values is shown in Table D–10 that follows:
Table D–10 SMS Priority Values Interpreted for Each SMS Profile Type|
Value |
GSM |
TDMA |
CDMA |
|---|---|---|---|
|
0 |
Non-priority |
Bulk |
Normal |
|
1 |
Priority |
Normal |
Interactive |
|
2 |
Priority |
Urgent |
Urgent |
|
3 |
Priority |
Very urgent |
Emergency |
With this option, the default priority to assign to SMS messages may be specified. When not specified, a default priority of 0 is used for PROFILE=GSM and CDMA, and a priority of 1 for PROFILE=TDMA.
Note that if USE_HEADER_PRIORITY=1 and an email message has an RFC 822 Priority: header line, then the priority specified in that header line will instead be used to set the priority of the resulting SMS message. Specifically, if USE_HEADER_PRIORITY=0, then the SMS priority flag is always set in accord with the DEFAULT_PRIORITY option and the RFC 822 Priority: header line is always ignored. If USE_HEADER_PRIORITY=1, then the originating email message’s RFC 822 Priority: header line is used to set the SMS message’s priority flag. If that header line is not present, then the SMS priority flag is set using the DEFAULT_PRIORITY option.
The mapping used to translate RFC 822 Priority: header line values to SMS priority flags is shown in table that follows:
Table D–11 Mapping for Translating Priority Header to SMS Priority Flags|
RFC 822 |
SMS priority flag | ||
|---|---|---|---|
|
Priority: value |
GSM |
TDMA |
CDMA |
|
Third |
Non-priority (0) |
Bulk (0) |
Normal (0) |
|
Second |
Non-priority (0) |
Bulk (0) |
Normal (0) |
|
Non-urgent |
Non-priority (0) |
Bulk (0) |
Normal (0) |
|
Normal |
Non-priority (0) |
Normal (1) |
Normal (0) |
|
Urgent |
Priority (1) |
Urgent (2) |
Urgent (2) |
DEFAULT_PRIVACY
(integer, -1, 0 - 255) Whether or not to set the privacy flag in an SMS message, and what value to use is controlled with the DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY options. By default, a value of -1 is used for DEFAULT_PRIVACY. Table D–12 that follows shows the result of setting the DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY options to various values.
Table D–12 Result of Values for DEFAULT_PRIVACY and USE_HEADER_SENSITIVITY|
DEFAULT_PRIVACY |
USE_HEADER_SENSITIVITY |
Result |
|---|---|---|
|
-1 |
0 |
The SMS privacy flag is never set in SMS messages. |
|
n >= 0 |
0 |
The SMS privacy flag is always set to the value n. RFC 822 Sensitivity: header lines are always ignored. |
|
-1 (default) |
1 (default) |
The SMS message’s privacy flag is only set when the originating email message has an RFC 822 Sensitivity: header line. In that case, the SMS privacy flag is set to correspond to the Sensitivity: header line’s value. This is the default. |
|
n >= 0 |
1 |
The SMS message’s privacy flag is set to correspond to the originating email message’s RFC 822 Sensitivity: header line. If the email message does not have a Sensitivity: header line, then the value of the SMS privacy flag is set to n. |
The SMS interpretation of privacy values is shown in Table D–13 that follows:
Table D–13 SMS Interpretation of Privacy Values|
Value |
Description |
|---|---|
|
0 |
Unrestricted |
|
1 |
Restricted |
|
2 |
Confidential |
|
3 |
Secret |
|
>= 4 |
Undefined |
The mapping used to translate RFC 822 Sensitivity: header line values to SMS privacy values is shown in Table D–14 that follows:
Table D–14 Mapping Translation of Sensitivity Headers to SMS Privacy Values|
RFC 822 Sensitivity: value |
SMS privacy value |
|---|---|
|
Personal |
1 (Restricted) |
|
Private |
2 (Confidential) |
|
Company confidential |
3 (Secret) |
DEFAULT_SERVICE_TYPE
(string, 0 - 5 bytes) Service type to associate with SMS messages generated by the channel. By default, no service type is specified (that is, a zero length string). Some common service types are: CMT (cellular messaging), CPT (cellular paging), VMN (voice mail notification), VMA (voice mail alerting), WAP (wireless application protocol), and USSD (unstructured supplementary data services).
DEFAULT_SOURCE_ADDRESS
(string, 0 - 20 bytes) Source address to use for SMS messages generated from email messages. Note that the value specified with this option is overridden by the email message’s originator address when USE_HEADER_FROM=1. By default, the value is disabled, that is, has a value of 0.
DEFAULT_SOURCE_NPI
(integer, 0 - 255) By default, source addresses will be assigned an NPI value of zero. With this option, an alternate integer value in the range 0 to 255 may be assigned. See the description of the DEFAULT_DESTINATION_NPI option for a table of typical NPI values.
DEFAULT_SOURCE_TON
(integer, 0 - 255) By default, source addresses will be assigned a TON designator value of zero. With this option, an alternate integer value in the range 0 to 255 may be assigned. See the description of the DEFAULT_DESTINATION_TON option for a table of typical TON values.
DEFAULT_VALIDITY_PERIOD
(string, 0 - 252 bytes) By default, SMS messages are not given a relative validity period; instead, they use the SMSC’s default value. Use this option to specify a different relative validity period. Values may be specified in units of seconds, minutes, hours, or days. Table D–15 that follows specifies the format and description of the various values for this option:
Table D–15 DEFAULT_VALIDITY_PERIOD Format and Values|
Format |
Description |
|---|---|
|
nnn |
Implicit units of seconds; for example, 604800 |
|
nnns |
Units of seconds; for example, 604800s |
|
nnnm |
Units of minutes; for example, 10080m |
|
nnnh |
Units of hours; for example, 168h |
|
nnnd |
Units of days; for example, 7d |
A specification of 0, 0s, 0m, 0h, or 0d may be used to select the SMSC’s default validity period. That is, when a specification of 0, 0s, 0m, 0h, or 0d is used, an empty string is specified for the validity period in generated SMS messages.
Note that this option does not accept values in UTC format.
DESTINATION_ADDRESS_NUMERIC
(0 or 1) Use this option to strip all non-numeric characters from the SMS destination address extracted from the email envelope To: address. For instance, if the envelope To: address is:
"(800) 555-1212"@sms.siroe.com
then it will be reduced to:
8005551212@sms.siroe.com
To enable this stripping, specify a value of 1 for this option. By default, this stripping is disabled which corresponds to an option value of 0. Note that when enabled, the stripping is done before any destination address prefix is added via the DESTINATION_ADDRESS_PREFIX option.
DESTINATION_ADDRESS_PREFIX
(string) In some instances, it may be necessary to ensure that all SMS destination addresses are prefixed with a fixed text string; for example, “+”. This option may be used to specify just such a prefix. The prefix will then be added to any SMS destination address which lacks the specified prefix. To prevent being stripped by the DESTINATION_ADDRESS_NUMERIC option, this option is applied after the DESTINATION_ADDRESS_NUMERIC option.
PROFILE
(string) Specify the SMS profiling to be used with the SMSC. Possible values are GSM, TDMA, and CDMA. When not specified, GSM is assumed. This option is only used to select defaults for other channel options such as DEFAULT_PRIORITY and DEFAULT_PRIVACY.
USE_SAR
(0 or 1) Sufficiently large email messages may need to be broken into multiple SMS messages. When this occurs, the individual SMS messages can optionally have sequencing information added using the SMS sar_ fields. This produces a “segmented” SMS message which can be re-assembled into a single SMS message by the receiving terminal. Specify USE_SAR=1 to indicate that this sequencing information is to be added when applicable. The default is to not add sequencing information and corresponds to USE_SAR=0.
When USE_SAR=1 is specified, the REVERSE_ORDER option is ignored.
- © 2010, Oracle Corporation and/or its affiliates