Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
Name
smpp esme create
SYNOPSIS
smpp esme create name password networkid
split-long-messages system-type
interface-version <3.3 | 3.4 | 5.0> esme-ton
esme-npi esme-range
cluster-name window-size
connect-timeout request-expiry-timeout
client-bind-timeout window-monitor-interval
window-wait-timeout counters-enabled
enquire-link-delay <30000> enquire-link-delay-server <0> link-drop-server <0> charging-enabled
source-ton source-npi
source-range routing-ton
routing-npi routing-range
ratelimit-second ratelimit-minute
ratelimit-hour ratelimit-day
national-language-single-shift
national-language-locking-shift
dest-addr-send-limit
min-message-length
max-message-length
DESCRIPTION
This command is used to configure a new ESME.
PARAMETERS
Standard Parameters
Name - A unique name for this ESME configuration. You can
define as many ESMEs as you want as far as the name is
unique and the combination of
SystemId:host-ip:port:SmppBindType is unique.
System Id - This is used to identify an ESME or an SMSC at bind
time. An 'ESME system_id' identifies the ESME or ESME
agent to the SMSC. The 'SMSC system_id' provides an
identification of the SMSC to the ESME. You can define
multiple ESMEs, each with a unique name but the same
systemId to allow anonymous incoming
binds and multiple binds from the same IP depending on
the values specified for host-ip and port.
host-ip & port - If the SMSC is acting as an ESME, the BIND request will
be sent to the configured IP and Port. If the SMSC is
acting as a Server, it will accept incoming BIND
requests from the specified IP and Port.
If the port is unknown, you must pass '-1' as wild
character.
When you define multiple ESMEs with the same systemId,if
host-ip and port values are -1 (for SMPP type Server),
the SMSC will accept multiple incoming BIND requests
from any IP:port as long as the systemId and password
match.
When you define multiple ESMEs with the same systemId,if
host-ip is a real value (a specific IP) and port value
is -1, the SMSC will accept as many BINDS as ESMEs
defined from the specified IP but any port as long as
the systemId and password match.
SmppBindType - Possible values: TRANSCEIVER, TRANSMITTER or RECEIVER.
If the SMSC is acting as an ESME, it will initiate
corresponding bind. If the SMSC is acting as a Server,
it will accept corresponding bind from a remote ESME.
SmppSession.Type - Possible values: SERVER or CLIENT.
If the value is 'SERVER', the SMSC acts as a Server
listening for incoming SMPP binds.
If the value is 'CLIENT', the SMSC will initiate
SMPP bind to a remote Server.
Optional Parameters
Password - It is used by the SMSC to authenticate the identity of
the binding ESME. The Service Provider may require
ESME’s to provide a password when binding to the SMSC.
networkId - indicates virtual subnetwork that this ESME belongs. SMS
flows within same netwrokId, unless changed using mproc
(this is for multi-tenancy support). If this parameter is
skipped - networkId will be set to "0" when ESME creation.
If you do not use multi-tenancy support - set this value
to 0 or skip.
split-long-messages - long messages will be split before sending to this
ESME destination. Default value is false.
system-type - Default value is null.
This is used to categorize the type of ESME that is
binding to the SMSC.
interface-version - Default value is 3.4.
It is used to indicate the version of the SMPP protocol.
It is set in 'SMPPServer Settings'.
esme-ton - Defines ESME TON. If the SMPP Session Type is CLIENT,
this TON will be used in the BIND request. If the SMPP
Session Type is SERVER, the incoming BIND request should
have the same TON as configured here. If the configured
value is null (-1), SMSC will ignore it in both cases.
esme-npi - Defines ESME NPI. If the SMPP Session Type is CLIENT,
this NPI will be used in the BIND request. If the SMPP
Session Type is SERVER, the incoming BIND request should
have the same NPI as configured here. If the configured
value is null (-1), SMSC will ignore it in both cases.
esme-range - Defines ESME Address Range. If the SMPP Session Type is
CLIENT, this Address Range will be used in the BIND
request. If the SMPP Session Type is SERVER, the
incoming BIND request should have the same Address Range
as configured here. If the configured value is
null (-1), SMSC will ignore it in both cases.
cluster-name - If it is not specified then its same as the name.
It is possible to group different SMPP connections
together by specifying the same cluster-name.
All the SMPP connection's that are capable of sending
out SMS are candidates for grouping.
window-size - Default value is 1.
The window size is the amount of unacknowledged requests
that are permitted to be outstanding/unacknowledged at
any given time. If more requests are added, the
underlying stack will throw an exception.
This value is set only when ESME is defined as Client
side. For Server side this value is taken from the
'SMPP Server Settings'.
connect-timeout - Default value is 10000 milli seconds.
This parameter is used to specify the time within which
the connection to a remote SMSC server should be
established.
This is useful only when ESME is defined as Client Side.
For Server side this value is taken from the
the 'SMPP Server Settings'.
request-expiry-timeout - Default value is -1 (disabled).
This parameter is used to specify the time to wait in
milli seconds for an endpoint to respond to before it
expires.
This is useful only when ESME is defined as Client Side.
For Server side this value is taken from the
the 'SMPP Server Settings'.
client-bind-timeout - Default value is 5000 milli seconds.
This parameter is used to specify the length of time
to wait for a bind response when the client connecting.
This is useful only when ESME is defined as Client Side.
window-monitor-interval - Default value is -1 (disabled).
This parameter is used to specify the time between
executions of monitoring the window for requests that
expire. It is recommended that this value, generally,
either matches or is half the value of
'request-expiry-timeout'. Therefore, in the worst case
scenario, a request could take upto 1.5 times the
'requestExpiryTimeout' to clear out.
This is useful only when ESME is defined as Client Side.
For Server side this value is taken from the
the 'SMPP Server Settings'.
window-wait-timeout - Default value is 60000 milli seconds.
This parameter is used to specify the time to wait
until a slot opens up in the 'sendWindow'.
This is useful only when ESME is defined as Client Side.
For Server side this value is taken from the
the 'SMPP Server Settings'.
counters-enabled - Default value is true.
When this is enabled, SMSC exposes the statistics for
SMPP connections.
This is useful only when ESME is defined as Client Side.
For Server side this value is taken from the
the 'SMPP Server Settings'.
enquire-link-delay - Default value is 30000 milli seconds.
When SMSC connects to a remote server as CLIENT, it
sends an 'ENQUIRE_LINK' after every configured
enquire-link-delay.
0 means disabled. SMSC will not send ENQUIRE_LINK.
enquire-link-delay-server - Default value is 0 milli seconds.
When SMSC connects to a remote server as SERVER, it
sends an 'ENQUIRE_LINK' after every configured
enquire-link-delay-server.
0 means disabled. SMSC will not send ENQUIRE_LINK.
link-drop-server - Time in milliseconds after which if ESME plays a SERVER role
and this option is enabled (> 0) SMSC GW will drop the esme
session if for this time there is no traffic in the ESME
(no incoming SMPP messages).
Values 0 or <0 disable the option.
If enquire-link-delay-server is enabled then link-drop-server
option value is not taken into account (it is always disabled.)
Default value is 0 (that means that the option is disabled).
charging-enabled - Flag to enable or disable charging for every SMS
arriving from SIP.
source-ton - Every SMS coming into the SMSC via this ESME should have
the same 'source_addr_ton' as the value configured here.
If this configured value is null(-1) or not null and
matches, the SMSC will compare the
'source_addr_npi' and 'source_addr_range' as explained
below.
If it doesn't match, the SMSC will reject this SMS with
an error code '0x0000000A' indicating
Invalid Source Address.
source-npi - Every SMS coming into the SMSC via this ESME should have
the same 'source_addr_npi' as the value configured here.
configured here.
If this configured value is null(-1)
or not null and matches, the SMSC will compare the
'source_addr_range' as below.
If it doesn't match, the SMSC will reject this
SMS with an error code '0x0000000A' indicating
Invalid Source Address.
source-range - Every SMS coming into the SMSC via this ESME should have
the same 'source_addr_range' as the value configured
here.This is a regular java expression and
default value is ^[0-9a-zA-Z]*.
If it matches, the SMSC will accept the incoming SMS
and process further.
If it doesn't match, the SMSC will reject this
SMS with an error code '0x0000000A' indicating
Invalid Source Address.
routing-ton - The DefaultSmsRoutingRule will try to match the
'dest_addr_ton' of outgoing SMS with the value
configured here. If this configured value is null(-1)
or not null and matches, the SMSC will compare the
'dest_addr_npi' and 'destination_addr' as explained
below. If it doesn't match, the SMSC will select the
next ESME in the list for matching routing rule.
DefaultSmsRoutingRule will consider ESME for routing
only if
1) SmppBindType is TRANSCEIVER
2) SmppBindType is RECEIVER and
SmppSession.Type is SERVER
3) SmppBindType is TRANSMITTER and
SmppSession.Type is CLIENT
routing-npi - The DefaultSmsRoutingRule will try to match the
'dest_addr_npi' of outgoing SMS with the value
configured here. If this configured value is null(-1)
or not null and matches, the SMSC will compare the
'destination_addr' as below. If it doesn't match, the
SMSC will select the next ESME in the list for matching
routing rule.
DefaultSmsRoutingRule will consider ESME for routing
only if
1) SmppBindType is TRANSCEIVER
2) SmppBindType is RECEIVER and
SmppSession.Type is SERVER
3) SmppBindType is TRANSMITTER and
SmppSession.Type is CLIENT
routing-range - The DefaultSmsRoutingRule will try to match the
'destination_addr' of outgoing SMS with the value
configured here. This is a regular java expression and
default value is ^[0-9a-zA-Z]*. If it matches, the SMSC
will send the SMS out over this SMPP connection. If it
doesn't match, the SMSC will select the next ESME in
the list for matching routing rule.
DefaultSmsRoutingRule will consider ESME for routing
only if
1) SmppBindType is TRANSCEIVER
2) SmppBindType is RECEIVER and
SmppSession.Type is SERVER
3) SmppBindType is TRANSMITTER and
SmppSession.Type is CLIENT
ratelimit_second - This parameter is used to specify a maximum limit
of messages that the SMSC will accept from this ESME
during any one second.
If the ESME sends more messages (per second)
than the maximum limit specified by 'ratelimit_second',
these additional messages will be rejected by the
SMSC GW along with an error code - "throttled".
The default value for this parameter is "0" and it
implies "no restrictions". If this parameter is not
specified it implies "no restrictions".
ratelimit_minute - This parameter is used to specify a maximum limit
of messages that the SMSC will accept from this ESME
during any one minute.
If the ESME sends more messages (per minute)
than the maximum limit specified by 'ratelimit_minute',
these additional messages will be rejected by the
SMSC GW along with an error code - "throttled".
The default value for this parameter is "0" and it
implies "no restrictions". If this parameter is not
specified it implies "no restrictions".
ratelimit_hour - This parameter is used to specify a maximum limit
of messages that the SMSC will accept from this ESME
during any one hour.
If the ESME sends more messages (per hour)
than the maximum limit specified by 'ratelimit_hour',
these additional messages will be rejected by the
SMSC GW along with an error code - "throttled".
The default value for this parameter is "0" and it
implies "no restrictions". If this parameter is not
specified it implies "no restrictions".
ratelimit_day - This parameter is used to specify a maximum limit
of messages that the SMSC will accept from this ESME
during any one day.
If the ESME sends more messages (per day)
than the maximum limit specified by 'ratelimit_day',
these additional messages will be rejected by the
SMSC GW along with an error code - "throttled".
The default value for this parameter is "0" and it
implies "no restrictions". If this parameter is not
specified it implies "no restrictions".
national-language-single-shift - National language single shift table can be
configured for messages that have come via SMPP (ESME) that
do not have UDHs inside and have GSM7 encoding (DCS==0). The
default GSM data coding table is mostly used. Possible values:
= 0 : default GSM data coding table
= 13 : urdu (arabic) national language shift table
= 1 : the national language locking shift value must be
obtained from the option national-language-single-shift
that is defined at SMSC GW general level.
national-language-locking-shift - National language locking shift table can be
configured for messages that have come via SMPP (ESME) that
do not have UDHs inside and have GSM7 encoding (DCS==0). The
default GSM data coding table is mostly used. Possible values:
= 0 : default GSM data coding table
= 13 : urdu (arabic) national language shift table
= 1 : the national language locking shift value must be
obtained from the option national-language-locking-shift
that is defined at SMSC GW general level.
dest-addr-send-limit - This command is used to set the value of Destination
Address Sending Limit table. destaddrsendlimit will be
used to limit the sent unconfirmed messages for a
destination address for an ESME. This is SMSC Gw level
and can be overwritten for each ESME created.
Default value: 0 - no limitations
min-message-length - This paramter is used to specify the minimum
message length (in characters) acceptable to
the SMSC GW, for messages coming from this ESME.
If an incoming message length is less than the
min-message-length it will be rejected by SMSC GW.
The default value for this parameter is "-1" and it
implies "no limitations". Any other negative value
also implies "no limitations".
max-message-length - This paramter is used to specify the maximum
message length (in characters) acceptable to
the SMSC GW, for messages coming from this ESME.
If an incoming message length is more than the
max-message-length it will be rejected by SMSC GW.
The default value for this parameter is "-1" and it
implies "no limitations". Any other negative value
also implies "no limitations".
EXAMPLES
smpp esme create test test 127.0.0.1 -1 TRANSCEIVER SERVER password yyyy esme-range 6667
SEE ALSO
smsc get scgt, smsc set scgt, smsc get scssn, smsc set scssn, smsc get hlrssn,
smsc set hlrssn, smsc get mscssn, smsc set mscssn, smsc get maxmapv,
smsc set maxmapv, smpp esme modify
