Configuration: ESME

ESME section

“esme"

This section of the configuration defines the routing of messages submitted by customers connecting to the SMPP Router. ESMEs are identified by the SMPP system ID in the SMPP bind request they issue after connecting to the platform. No passwords are configured in the SMPP Router.

If the system ID is not defined in this section, the “default" target set will be assumed.

Each entry in the esme section identifies a system ID ("systemid") and the associated target set ("sharedtargetsetid").

Field	Description	Example
`systemid`	Customer’s SMPP system ID mandatory	`"abcdef"`
`password`	Customer’s SMPP password optional	`"NUO0t4pR"`
`password_hash`	Customer’s SMPP password hash Used instead of plaintext `password`. Generate as follows and use output after colon: `htpasswd -nbB esme001 NUO0t4pR` esme001:$2y$05$Y6p… optional	`"$2y$05$Y6p…"`
`allowedips`	List of IP addresses allowed to connect to the SMPP Router using this ESME’s system ID. optional	`["192.168.100.101"]`
`sharedtargetsetid`	Identifier (id) of target set to where ESME’s traffic should be routed A reserved identifier `INTERNAL_SMSC_SIM` can optionally be used to specify the SMPP Router’s internal SMSC simulator. mandatory	`"0001"`
`tpslimit`	Maximum allowed number of SubmitSM per second (TPS) for each bind SMPP throttle error will be returned if attempt to exceed limit. optional Default: 65535	`5000` (5000 SubmitSM per second)
`binding_enabled`	Allow binding by ESME If disables (false), ESME will not be able to bind to SMPP Router. optional Default: true	`true`
`submits_enabled`	Allow SubmitSM from ESME If disabled (false), command status (error) 69 will be returned to ESME. optional Default: true	`true`
`inboundmo`	Array of destination addresses (e.g. MSISDNs, short codes) for which this ESME should receive MO SMS Will match exactly with address or pattern match with a regular expression. optional	JSON `["99360701", "99360702", "99360703"]` JSON `["^99361", "447720334455", "^447830100[0-4]"]`
`routes-mt`	Routing to be applied to MT SMS submitted by the ESME See Routing optional	JSON `{ "criteria": { "match": "destination", "type": "country", "value": "33" }, "targetset": "0002" }`

[data-colorid=crxjzozlze]{color:#ff5630} html[data-color-mode=dark] [data-colorid=crxjzozlze]{color:#cf2600}ESME section

ESME section