SMS Gateway 4.4 - User's Guide

12. Keyword reference

Here we describe the syntax of each keyword in the configuration file, SMSDIR/config.

The keywords below are used in the configuration file SMSDIR/config. The file can be modified with an ordinary text editor. After modifying the file the smsd has to be stopped and restarted for the changes to become activated.

When using multiple modem devices keywords specific for a certain tty (local keywords) can be used by using the following syntax:

LINE tty <
keyword
keyword
...
>

For example:

LINE tty1a <
INIT_STRING="AT&H3"
DIAL_PREFIX="0W"
>

This makes it possible to use different modems etc.

Please note that the global keywords, keywords used for all lines, must be defined before the local keywords. If a keyword is used more than once the last instance will be used.

12.1 General parameters

12.1.1 LINES

LINES=tty1[:tty2...]

Defines which port(s) to use. /dev should not be included in the name. Please note that the number of ports used is limited by the license as well. Example: LINES=tty1A

12.1.2 ACCESS_HTTP

ACCESS_HTTP=string

Specifies which hosts or network can access the HTTP server.

Example:

ACCESS_HTTP=10.1.11.10/32,10.5.1.0/24

12.1.3 ACCESS_SMTP

ACCESS_SMTP="string"

Specifies which hosts or network can access the SMTP server.

Example:

ACCESS_SMTP=10.1.11.10/32,10.5.1.0/24

12.1.4 ACCEPT_USERS

ACCEPT_USERS="user1[:user2 ...]"

Specifies that only the given users are allowed to use a modem device. Useful when having multiple devices where a specific device should be dedicated to specific users.

12.1.5 ADMINISTRATOR

ADMINISTRATOR="string"

Defines which users are system administrators. As a SMS system administrator you can display and manage all users message queues. More than one administrator can be defined by separating user names with colon ":". Example:

ADMINISTRATOR="root:kalle".

12.1.6 BROKEN_SELECT

BROKEN_SELECT

Not used.

12.1.7 BUSY_FAIL

BUSY_FAIL=tries

Defines the number of transmission tries when the recipient number is busy. If BUSY_FAIL is not defined the number of tries is defined by MAX_TRIES.

12.1.8 CHAR_SET

CHAR_SET=character set or
CHARACTER_SET=character set

Specifies the character set to be used.

Default: 5 (swedish 7-bit mapping)

12.1.9 CIMD_LOGIN

CIMD_LOGIN=login

Specifies the login to use with the CIMD protocol.

12.1.10 CIMD_PASSWORD

CIMD_PASSWORD=password

Specifies the password to use with the CIMD protocol.

12.1.11 CIMD_VP

CIMD_VP=seconds

Defines, for the CIMD protocol, how long, in seconds, a message will be stored in the SMSC. A negative number indicates that the message should not be stored if it cannot be sent immediately.

12.1.12 DEBUG

DEBUG

Write debug information to standard output, that is to the display.

12.1.13 DEFAULT_GATEWAYS

DEFAULT_GATEWAYS

Specifies that the default gateways (dial-up gateways for swedish operators) should be added. This makes it possible to add a gateway to the existing ones. If DEFAULT_GATEWAYS is omitted none of the default gateways will be added if there is a GATEWAY definition in the config file.

12.1.14 DENY_USERS

DENY_USERS="user1[:user2 ...]"

Specifies that the given users are not allowed to use a modem device. Useful when having multiple devices where a specific device should not be available to specific users.
See also: ACCEPT_USERS

12.1.15 DIAL_PREFIX

DIAL_PREFIX="string"

Defines a prefix added to the phone number when dialing out. For example, use something like DIAL_PREFIX="0W" to get through a switchboard.

12.1.16 DIAL_TIMEOUT

DIAL_TIMEOUT=seconds

Defines the number of seconds to wait after dialing the phone number, before the try is considered a failure if a connection has not been established.

12.1.17 DIRECT

DIRECT=bps,bits,parity,stop bits

Used to define a direct serial connection instead of a modem connection to the SMSC.

12.1.18 DOMAIN

DOMAIN=domain

Specifies the domain name to use when sending e-mail.

12.1.19 EXEC_WORKDIR

EXEC_WORKDIR=directory

Defines the work directory to use for commands executed by EXECUTE_AFTER_SEND.

12.1.20 EXECUTE_AFTER_RECEIVE

EXECUTE_AFTER_RECEIVE=program

Gives a program which is executed after receiving a message.The program is executed with the following arguments in the sequence given:

Sender The sender of the message.

Recipient The recipient of the message (may be emtpy).

Message The actual message.

12.1.21 EXECUTE_AFTER_SEND

EXECUTE_AFTER_SEND=program

Defines a program, or script, to be executed after a message has been transmitted or is considered a failure.The program is executed with the following parameters:

ID Message id

Rec number The recipient number

Result code A numeric value: 0 - OK 6 - No Dialtone 7 - Busy 8 - No Answer

Tries Number of transmission tries

Note Note attached to the message. Added with the -n parameter for sms

Secs connected Number of seconds connected during the transmission tries

Finished Time when the message was finished, that is sent or failed

User User who sent the fax

SCTS Service Center Time Stamp from SMSC (may be emtpy)

Error text Error text from SMSC (may be emtpy)

Message The actual message

12.1.22 EXIT_STRING

EXIT_STRING="string"

Specifies a command string to be sent to the modem after a transmission. Please note that ATZ (reset) is always sent to the modem before the specified string.

12.1.23 FLOW

FLOW=value

Use FLOW=0 to disable hardware flow control for modem connections.

12.1.24 GATEWAY

GATEWAY=prefix:name:type:address:port:protocol[:extra]

Makes it possible to define custom gateways.

Europolitan via modem:

GATEWAY=0708:Euro:MODEM:0708222109:0:CIMD

Generic UCP via IP (port 7169):

GATEWAY=DEFAULT:Generic:IP:10.1.2.3:7169:UCP

Prefix Prefix for gateway, for example 0708 for Europolitan. Can also be DEFAULT.

Name Name of the gateway.

Type Type of connection: IP or MODEM.

Address IP-address or phone number.

Port If IP is used the port number is entered here. Not used when not using IP.

Protocol Protocol to use CIMD, COMVIQ, CIMD2, EURO, SMPP, TAP, TELIA, THS, UCP or UCPE.

Extra Parameters as in the Gateway keywords section below.

12.1.25 HOST

HOST=string

Specifies which host that runs the SMS Gateway server, smsd, usually the local machine. An IP address or host name can be used. If a host name is used the name resolver must work. Hence, using an IP address is more reliable but has to be changed if the IP address of the machine changes.

12.1.26 HTTP_ACCESS

HTTP_ACCESS=string

Specifiy rules for HTTP access.

12.1.27 HTTP_ENABLE

HTTP_ENABLE

Enable the SMS Gateway integrated HTTP server.

12.1.28 HTTP_PORT

HTTP_PORT=number

Specifies which port the HTTP server should listen on.

Default: 7181

12.1.29 ID

ID=string

Specifies the sender or originator for a message. This, for example, corresponds to the OAdC field in UCP. Usually the originating GSM subscriber number which the recipient would reply to.

12.1.30 INIT_STRING

INIT_STRING="string"

Defines a initialisation string to be sent to the modem before dialing out. Here you can add modem-specific commands needed to set up flow control etc. Example:

INIT_STRING="AT&K4M1L2"

12.1.31 INT_PREFIX

INT_PREFIX=string

Specifies the prefix for international calls. 00 in Sweden.

12.1.32 LANG

LANG=language code or
LANGUAGE=language code

Specifies the language to be used. Possible values eng, swe and swe8.
Default: eng

12.1.33 LD_PREFIX

LD_PREFIX=string

Specifies the long-distance prefix. Default: 0 in Sweden

12.1.34 LINE_FAIL

LINE_FAIL=tries

Specifies the number of tries when the modem cannot be initiated.

12.1.35 LOCK_DIR

LOCK_DIR=library

Specifies which directory to use for tty lock files.

12.1.36 LOCKING_STYLE

LOCKING_STYLE=value

Indicates which type of locked files should be created when locking fax lines. This is dependent on the operating system.

Values:

1 Linux
2) SCO
3 System V.4
4 HP-UX

12.1.37 MAIL_ON_ERROR

MAIL_ON_ERROR

Specifies that an email should be sent to the user sending the message when the message could not be sent.

12.1.38 MAIL_ON_SUCCESS

MAIL_ON_SUCCESS

Specifies that an email should be sent to the user sending the message after the message has been sent.

12.1.39 MAX_RETRIES

MAX_RETRIES=tries

Specifies the maximum number of tries to send a message before the message is put in the failed messages queue.

12.1.40 MAX_SEND_ENTRIES

MAX_SEND_ENTRIES=number

Specifies the maximum number of messages to send to the SMSC during one session. Some SMSC's only accept a certain number of messages during one session.

12.1.41 MINICALL_GATEWAY

MINICALL_GATEWAY=telno

Specifies the number for Telia:s Minicall Text Gateway
Default: 020-910028

12.1.42 MINICALL_ID

MINICALL_ID=id

Specifies the user id for Minicall Text.

12.1.43 MINICALL_PASSWORD

MINICALL_PASSWORD=password

Specifies the password for Minicall Text.

12.1.44 NO_STATISTICS

NO_STATISTICS

Specifies that no statistics information should be written to ETCDIR/stats.

12.1.45 PORT

PORT=value

Specifies which port to use for communication between smsd and the client programs.
Default: 6002

12.1.46 PULSE

PULSE

Indicates that pulse dialing should be used.

12.1.47 QUIET

QUIET

Specifies that client programs should be quiet and not write information to stdout as done by default. This is the same as using the -q option with the sms commands.

12.1.48 RETRY_TIME

RETRY_TIME=minutes

Defines the number of minutes between two consecutive transmission tries.

12.1.49 SMTP_ENABLE

SMTP_ENABLE

Enable the SMS Gateway integrated SMTP server.

12.1.50 SMTP_PORT

SMTP_PORT=number

Specifies which port the SMTP server should listen on.

Default: 7183

12.1.51 SPOOLDIR

SPOOLDIR=directory

Defines the directory where files used during transmission are stored.
Default: /usr/spool/sms

12.1.52 SYMBOL_SET

SYMBOL_SET=character set

Defines the symbol set to be used.Values: 0 = Roman-8, 1 = Latin-1 (ISO 8859-1).
Default: 1 (Latin-1)

12.1.53 TAP_PASSWORD

TAP_PASSWORD=string

Specify the default password for a TAP gateway.

12.1.54 TONE

TONE

Specifies that tone dialing should be used (default).

12.1.55 UCP_MT

UCP_MT=string

Specifies the default message type for UCP.

12.1.56 UCP_NRQ

UCP_NRQ=string

Specifies the default NRQ for UCP. Set this to 1 if you want the delivery to be confirmed before the connection is dropped. 0 means to ignore whether the message could be delivered or not, always successful.

12.1.57 UCP_OT

UCP_OT=string

Specifies the OT (Operation Type) for UCP.

Default value: 51

12.1.58 UCP_VP

UCP_VP=string

Specifies the default validity period for UCP gateways. This is the period in number of seconds a message will be stored in the SMSC if it cannot be delivered.

12.1.59 USE_POOL

USE_POOL=connections

Specifies that we want static IP. The maximum number of connections is given as argument.

12.1.60 USE_SHM

USE_SHM

Specify that the server should use Share Memory for inter-process communication. Not all platforms support Shared Memory.

12.1.61 USER_FILE

USER_FILE=filename

Specifies a file to use for valid users of the HTTP or SMTP server.

Format of the file: username<TAB>password<TAB>type of server
Example:

user1      secret  HTTP
user2      moresecret  HTTP,SMTP
user@domain.com      sec123  HTTP,SMTP

12.2 Gateway parameters

These parameters can be specified in the last field (extra) of a gateway definition. Multiple parameters can be specfied ","-separated.

12.2.1 AUTHNPI

AUTHTONNPI=integer

12.2.2 AUTHTON

AUTHTON=integer

12.2.3 MODE

MODE=string

String can containg the letters `S' and `R' to specify whether the gateway should be used for sending messages, receiving messages or both.

12.2.4 NOSCA

NOSCA

Specifies that SCA (Service Center Address) should not be included in PDU when sending messages.

12.2.5 OPERATION

OPERATION=string

If specified this operation will be used as send operation.

For example OPERATION=51 when using UCP will specify that the UCP operation 51 will be used to send messages.

12.2.6 PASSWORD

PASSWORD=string

If specified this password will be used when logging in to gateway.

12.2.7 SCA

SCA=string

If specified string will be used to set SCA (Sercice Center Address) during init of a GSM phone.

12.2.8 SESSION_PASSWORD

SESSION_PASSWORD=string

Specifies a password to use with the UCP session management operation, when logging in to a UCP SMSC.

12.2.9 SESSION_USERNAME

SESSION_USERNAME=string

Specifies a username/Large Account to use with the UCP session management operation, when logging in to a UCP SMSC.

12.2.10 SMSID

SMSID=string

Specifies a sender, originating address, for the specific gateway.

12.2.11 STORE

STORE=string

String can be "SM" or "ME" to specify which message store (SIM card or Memory) should be used when using a GSM device as gateway.

12.2.12 WAITFOR

WAITFOR=string

Specify a string to wait for after connect.