Adobe 38043740 - ColdFusion Standard - Mac Development Manual page 1302

DEVELOPING COLDFUSION 9 APPLICATIONS
Using External Resources
Configuring an SMS event gateway
You provide SMS-specific configuration information to the SMS event gateway in a configuration file. You specify the
configuration file location when you configure the SMS event gateway instance in the ColdFusion Administrator.
ColdFusion provides a sample SMS event gateway configuration file in cf_root\WEB-
INF\cfusion\gateway\config\sms-test.cfg on J2EE configurations, and cf_root\gateway\config\sms-test.cfg on server
configurations. The following table describes the configuration file contents.
Note: The following configuration information describes the configuration fields, but does not include detailed
explanations of SMPP-specific terminology, listings of all valid values of properties that are defined in the SMPP
specification, or explanations of how to select appropriate SMPP-specific values for your application. For further
information, see documentation on the SMPP 3.4 protocol at www.smsforum.net/ and other publicly available
documentation. Your SMS service provider generally specifies requirements for several of these configuration values.
Consult the provider documentation.
Property Default
ip-address
port 0
system-id
password
source-ton 1
source-npi 1
source-address empty string
addr-ton 1
addr-npi 1
address-range
message-rate 100
mode synchronous
network-retry no
Description
IP address of the SMSC, as specified by the SMPP provider. For the ColdFusion SMS test
server, you normally use 127.0.0.1.
Port number to bind to on the SMSC. The ColdFusion SMS test server uses port 7901.
Name that identifies the event gateway to the SMSC, as established with the SMPP provider.
To connect to the ColdFusion SMS test server, the system-id must be cf.
Password for authenticating the event gateway to the SMSC. To connect to the ColdFusion
SMS test server, the password must be cf.
Type of Number (TON) of the source address, that is, of the address that the event gateway
uses for outgoing messages, as specified in the SMPP specification. Values include 0,
unknown; 1, international number; 2, national number.
Numeric Plan Indicator (NPI) of the source address as specified in the SMPP specification.
Values include 0, unknown; 1, ISDN.
Address (normally, a phone number) of the event gateway. Identifies the sender of
outgoing messages to the SMSC.
TON for the incoming addresses that this event gateway serves.
NPI for the incoming addresses that this event gateway serves.
The range of incoming addresses (phone numbers) that remote devices can use to send
messages to the event gateway instance; often, the same as the
Integer or decimal value that specifies the number of messages the gateway is allowed to
send to your service provider per second. 0 is unlimited.
Message transmission mode:
•
synchronous The gateway waits for the response from the server when sending a
message. In this mode, the
SendGatewayMessage
of the message, or an empty string if an error occurs.
messageID
•
asynchronous The gateway does not wait for a response. In this mode, the
SendGatewayMessage CFML function always returns an empty string.
Gateway behavior when a network error occurs while trying to deliver a message:
•
yes The gateway queues the message for delivery when the gateway is able to rebind
to the SMSC. Retrying is useful if the gateway is in asynchronous mode, where the CFML
SendGatewayMessage function does not return an error.
•
no The gateway does not retry sending the message.
Last updated 1/20/2012
source-address .
CFML function returns the SMS
1297