SET

The SET command is an optional command and is used primarily to override the values defined in the SMSService.properties file.

To set multiple keywords inside your application you may either use the SET command multiple times, or use one SET command with multiple keywords defined in it.

 

                                                           Optional

 

 SET ------------- TRANSPORT ------- *HTTP ----------------------->

                                     *SMTP

 

               >-- PROVIDER  ------- *KAPOW ---------------------->

                                     *VIANETT

                                     *BULKER

                                     *STREETDATA

                                     *TEXTMARKETER

                                     *INTELLISOFTWARE

 

               >-- HOST ------------ value ----------------------->

 

               >-- SENDER ---------- value ----------------------->

 

               >-- SECURE ---------- *NO ------------------------->

                                     *YES

 

               >-- URI ------------- value ----------------------->

 

               >-- ACCOUNT_USER ---- value ----------------------->

 

               >-- ACCOUNT_PASSWORD- value ----------------------->

 

               >-- SERVER ---------- value ----------------------->

 

               >-- PORT ------------ value ----------------------->

 

               >-- MAILDOMAIN ------ value ----------------------->

 

               >-- MOBILEDOMAIN ---- value ----------------------->

 

               >-- FROM ------------ value ----------------------->

 

               >-- CHARSET --------- value ----------------------->

 

               >-- ENCODING -------- value ----------------------->

 

               >-- SUBJECT --------- value -----------------------|

 

Keywords

TRANSPORT

This is used to nominate the transport mechanism you will use to send the SMS details to the SMS gateway service provider.

There are two options:

*SMTP indicates that the SMS details are to be sent by email to the SMS gateway service provider.

*HTTP indicates that the SMS details are to be sent by HTTP to the SMS gateway service provider. The transport you select will likely be based on the service you subscribe to with the SMS gateway service provider.

This keyword can be used to override the transport value in the SMSService.properties file.

PROVIDER

This keyword is only used with the *HTTP transport.

You will only use it if you have selected *HTTP as your transport.

This keyword can be used to override the provider value in the SMSService.properties file.

HOST

This keyword is only used with the *HTTP transport.

This is the host value supplied to you by the SMS gateway service provider.

This keyword can be used to override the host value in the SMSService.properties file.

SENDER

This keyword is only used with the *HTTP transport.

This identifies the sender of the SMS message.

This feature is optional as some providers do not support it.

This keyword can be used to override the sender value in the SMSService.properties file.

SECURE

This keyword is only used with the *HTTP transport.

You will set this value to *YES to indicate that you would like to send the details using SSL (encrypted HTTPS).

The default value at installation is *NO.

This keyword can be used to override the secure value in the SMSService.properties file.

URI

This keyword is only used with the *HTTP transport.

This is the HTTP resource supplied to you by the SMS gateway service provider.

This keyword can be used to override the uri value in the SMSService.properties file.

ACCOUNT_USER

This keyword is only used with the *HTTP transport.

This is your account name supplied to you by your SMS gateway service provider.

This keyword can be used to override the account.user value in the SMSService.properties file.

ACCOUNT_PASSWORD

This keyword is only used with the *HTTP transport.

This is the password for your account.

This keyword can be used to override the account.password value in the SMSService.properties file.

SERVER

This keyword is only used with the *SMTP transport

This is the address of the SMTP server you are using to send the email that contains the SMS details.

This keyword can be used to override the server value in the SMSService.properties file.

PORT

This keyword is only used with the *SMTP transport.

This is the TCP/IP port that the SMTP mail server is running on.

The default value is 25.

This keyword is optional.

This keyword can be used to override the port value in the SMSService.properties file.

MAILDOMAIN

This keyword is only used with the *SMTP transport.

This is the mail domain as issued by the SMTP HELO command. This value tells the SMTP server that this is your mail domain.

This keyword is optional.

This keyword can be used to override the mail.domain value in the SMSService.properties file.

MOBILEDOMAIN

This keyword is only used with the *SMTP transport.

This is the mail domain to which you will send the email with the SMS details.

Normally the mobile phone number you are sending the SMS to will prefix this value. So for example, if you are sending the SMS to a number 12345678 and the mobile domain is streetdata.com.au, then the full email address that the message will be sent to is 12345678@streetdata.com.au.

This keyword can be used to override the mobile.domain value in the SMSService.properties file.

FROM

This keyword is only used with the *SMTP transport.

This is the FROM address of the email that you want emails responses from the SMS gateway service provider routed back to. Such responses might include SMS status information (such a failed SMS).

This would normally be one of your company email addresses - perhaps one that is dedicated to receiving such responses. It should be a valid email address. Many providers will only accept values that are already registered with them.

The value supplied will be appended to the mail domain so you only need to enter the first part of the address. For example, if the mail domain is mycompany.com and you supply a FROM value of john.smith then full return email address will be john.smith@mycompany.com.

This keyword can be used to override the from.address value in the SMSService.properties file.

CHARSET

This keyword is only used with the *SMTP transport.

This is the character set encoding of the body text and subject.

This keyword is optional.

This keyword can be used to override the charset value in the SMSService.properties file.

ENCODING

This keyword is only used with the *SMTP transport.

This is the body text encoding

This keyword is optional.

This keyword can be used to override the encoding value in the SMSService.properties file.

SUBJECT

This keyword is only used with the *SMTP transport.

This will contain the subject of the email.

Typically this would contain your user account and account password (in the format user+password) for the SMS gateway that you are using. Do confirm with your provider as they may have their own format.

This keyword can be used to override the subject value in the SMSService.properties file.

Examples

RDML

 

USE BUILTIN(JSM_COMMAND) WITH_ARGS('SET ACCOUNT_NAME(USERID) ACCOUNT_PASSWORD(USERPWD) TO_GET(#JSMSTS #JSMMSG)

 

RDMLX

 

use builtin(jsmx_command) with_args(#jsmxhdle1 'set account_name(userid) account_password(userpwd)') to_get(#jsmxsts #jsmxmsg)