SMS Send

This SMS tool allows handlers to send SMS Objects to the SMS Server.

Note: This tool does not actually send the message to the SMS Broker. That is done with the SMS CompleteSend tool. This tool initiates the handler System_OutgoingSMS which calls the SMS CompleteSend tool.

Inputs

SMS Identifier

The unique identifier for the SMS Object.

Remote Name

The name of the recipient of the SMS Object. If the message is to be sent to more than one recipient, this parameter should be left blank. Multiple Remote Names should be added to the EicRemoteName attribute using the QueueManager’s vector functions.

Remote Telephone Number

The telephone number of the intended recipient of the SMS Object. This parameter may contain multiple phone numbers. This allows text/binary messages to be sent to several cell phones.

Message

The text/binary file to be added to the SMS Object.

Binary Message?

Check this box if the message is binary.

Truncate to 160 Characters

Check this box if you want the text of a non-binary message to be truncated to 160 characters.

Priority

The priority of the SMS Object. A value of 0 (default) denotes normal priority, use 1 for High priority, and 2 for Urgent.

Note: High and Urgent priorities often require a special subscription with the SMS Broker. Sending messages at these priorities without the necessary subscription may cause an exception.

SMS Broker Class

This integer corresponds to a class attribute for the SMS Broker. The following values may be used:

0:  Immediate display. The message will not be registered by the mobile phone.

1: The message will be stored on the Mobile Phone.

2: The message will be stored on the SIM card.

3: The message will be stored on the Terminal Equipment. Used for SIM toolkit and Over The Air short messages.

4: None (default)

SMS Broker Notification

If used, there will be a Status Report (SR) message generated when the MT message is sent. SMS Notifications can be sent when the message is delivered, not delivered, pending, etc.

Note: Notifications usually requires a special subscription with the SMS Broker. Asking for a notification without the necessary subscription will either cause an exception or simply get ignored, depending on the SMS Broker. Check with your SMS Broker to confirm the values associated with valid notification types.

Timeout

The number of seconds to wait for the message to be sent. Enter a value of zero to use the system default timeout period.

Number of tries

The number of times to try the operation if it fails.

Codepage

This integer is the EBCDIC code page to use. This field is only available if the EBCDIC custom encoding is selected. Currently, only the code page 290 is supported. This integer is set to 0 if not used.

Delayed until

If you want to delay the sending of this message, enter the date you want to have the message sent.

Valid until

Date on which the SMS message will expire.

Send As

The SMS Broker to send from. This input can indicate the default, a user, or a workgroup. Leave this input blank to indicate the default which uses the SMS Outbound Routing table to choose the broker account to send from. Use the following format to indicate a user or workgroup:

<userId>|<AssociationType>|<Association>|<Broker>|<BrokerAccountId>|<BrokerAccountLocalAddress>

<userId>

The user ID of the user initiating the SMS message send.

<AssociationType>

U (user) or W (workgroup) for broker accounts associated with users or workgroups.

<Association>

The user ID or workgroup name of the user or workgroup that is associated with t he desired broker account.

<Broker>

The name of the broker as configured in Interaction Administrator.

<BrokerAccountId>

The name of the broker account ID as configured in Interaction Administrator.

<BorkerAccountLocalAddress>

The broker account local address as configured in Interaction Administrator.

 Notes:

• If any of the information in the Send As parameter is incorrect or not configured correctly in Interaction Administrator (for example, if the association between the account and the workgroup/user does not exist), the default is used.

• If any of the strings in any of these values in the Send As parameter contain pipe characters (|) or ampersands (&), those strings must be escaped as shown in the following example:

 private string EscapePipeDelimitedString(string str)

    {

        str = str.Replace("&", "&amp;");

        str = str.Replace("|", "&#124;");

                    return str;

    }

                          

Exit Paths

Success

This path is taken if the message is successfully sent to the SMS Server.

Failure

This path is taken if the operation fails.