Configuration

Configuration for the SHB is stored in the shb.conf file on the file system of the SHB host.

An example shb.conf configuration file is shown below:

JSON

{
  "base": {
    "defaultType": "jsonPOST",
    "defaultConfig": "..."
  },
  "entries": [
    {
      "smppSystemID": "user001",
      "smppPassword": "pass001",
      "callback": "user001"
    },
    {
      "smppSystemID": "user002",
      "smppPassword": "pass002",
      "callback": "user002"
    }
  ]
}

The “base” section defines the defaultType and defaultConfig entries that are used as the default adapter type and config for elements in the “entries” section.

Adapters types

A number of different providers and APIs can be supported through adapter types implemented in the SMPP-HTTP Bridge. Below is a description of one of the generic adapters types that can be configured to support different providers.

If you require additional API supplier, please contact support@melorselabs.com.

Adapter: jsonPOST

The jsonPost adapter will take SMS messages contained in SMPP submit_sm PDUs and submit them to a HTTP(S) endpoint. The short_message field containing the message is converted to UTF8 based on the data_coding field in the submit_sm PDU and the dcsMCSpecificMeaning configuration value.

Configuration

Parameter	Description	Example
smppsystemid	SMPP system ID used by customer/ESME to connect to configured bridge
smpppassword	SMPP password associated with system ID
dcsMCSpecificMeaning	Character set when data coding scheme (DCS) of message is 0 ("MC default alphabet"). 1: IA5/ASCII, 3: Latin1/ISO 8859-1 (3), 8: UCS2	`8` (UCS2)
urlSendSMS	API endpoint URL	`https://api.smsprovider.com`
sourceAddress	Key that should be used for source address in JSON request to API	`senderId`
destinationAddr	Key that should be used for destination mobile number in JSON request to API	`mobileNo`
message	Key that should be used for text message in JSON request to API	`content`
messageID	Key in JSON response that is used for message ID on successful submission of message to API. This field can be nested within the response.	`msgId`
sarRef	Key in JSON request that should be used for concatenated SMS reference.	`sarref`
sarTotal	Key in JSON request that should be used for concatenated SMS total parts.	`sartotal`
sarPart	Key in JSON request that should be used for concatenated SMS part number.	`sarpart`
sarMetaAlways	Controls whether concatenated SMS meta data (sarRef, sarTotal, sarPart) area always included, even when not concatenated SMS.	`false` (Exclude concatenated SMS meta when single part message)
forceDeliveredOnSubmission	Generation of DLR indicating message delivered. Used when API does not provide delivery status.	`true` (Generate "delivered" DLR)
urlCallback	Key in JSON request that should be used for the callback URL where DLRs are sent by provider	`callback`
dlrQueueName	Internal - Queue to where received DLRs are routed (normally system ID of bridge account)
callback	Internal - Path in callback URL for receiving DLRs specific to a bridge configuration	`abacus-uylPLNQR` (http://a.b.c.d:15680/abacus-uylPLNQR callback URL)
_additional	Array of additional elements to be included in JSON POST	JSON `{"username":"1234567890"}`
headers	Array of strings to be added to the HTTP header	JSON `["apikey: 1234567890"]`
status_field	Key in JSON DLR callback that contains the message status field.	`status`
status_map	Map of status field values received in HTTP callback and their mappings to SMPP DLR equivalent	JSON `{"Delivered":2,"Undelivered":5}`

Contact support@melroselabs.com for help setting-up an SMPP-HTTP Bridge.