Skip Navigation

Configure the hosted SMS plug-in settings

  1. In the 
    NDS
     console, click 
    Management
     > 
    Configure
    .
  2. Click 
    New Configuration
    .
  3. In the 
    New Key
     field, enter the following value: 
    nds.plugins.sms
    .
  4. Open 
    Windows Explorer
     and navigate to the following file: 
    AtHocENS
    /DeliveryServer/Plugins/SMS/nds.plugins.sms.sql
    .
  5. Copy the contents of the file and close the file.
  6. Return to the 
    NDS
     console and paste the file contents in the 
    Value
     field.
  7. Update the following attribute values, as appropriate for the customer setup:
    • <pluginconfig>
      • hostname
        : Specifies the public IP address for the 
        NDS
         server.
      • selfTestInterval
        : Specifies the frequency of the connection test, in seconds, with the Open Market (third-party message aggregator) server.
      • splitPages
        : Specifies whether to split messages if they have more than 160 ascii or 70 unicode characters (in Canada ASCII 136, Latin 136). "true" or "false".
      • concatSm="true"
        : Indicates that the concatenate SMS feature is enabled. "true" or "false".
      • tlsMode="must"
        : Indicates that the TLS is enabled. The default value is set to "none". When TLS is turned on, the port in the gateway configuration must be changed to the appropriate TLS port.
      • responseUrl
        : Indicates the base URL for link-based responses.
    • <gateway>
      • hostname
        : Specifies the Open Market IP addresses for the Hosted SMS servers. (Open Market is the 3rd party vendor for handling SMS messages.)
      • accountId
        : Specifies the ID for the AtHoc account with Open Market.
      • spellbind
        : Defines the number of connections for the specified gateway type.
      • throttle
        : Displays the number of SMS messages sent to the gateway each second.
      • failoverOrder
        : Defines the order in which parallel accounts come online during a failover situation.
      • enabled
        : Indicates whether the Open Market account is enabled. "true" or "false".
      • vendorCode
        : Displays the code for Open Market.
      • sourceAddress
        : Displays the 5 digit short code for the sender that users see when they get a text message.
      • programId
        : Specifies the ID provided by Open Market that verifies the source of the message.
    • <country>
      • name
        : Specifies the name of the country. For example, ‘CANADA’.
      • sourceAddress
        : Specifies the source address of the country. For example, 73101.
      • npi
        : Value is ‘1’.
      • responseInstruction
        : Specifies the number that the user can respond to, in the text message. For example, <India ..... responseInstruction="To respond send text at +911234567890"><India>.
      • canReply
        : Specifies that you can receive a reply from a country and the link response can be used. This setting can be used with account level responseMode setting to send link response or reply. If the value is set to "true"(default), you can receive a reply from a country. If the value is set to "false", you cannot receive a reply from the country.
      • disableConcatSm
        : If the value is set to "true", the concatSm flag is disabled at the country level. If the value is set to "false" concatSm flag is enabled at country level.
      • ton
        : Specifies the type of source address of a country. The values are 3 for short code, 1 for international, 5 for alphanumeric. If no value is specified, the application has a logic to determine the appropriate TON for that country.
    • <keyword>
      • name
        : Specifies the 
        SMS
         keyword that the user enters to send a message to the organization. For example, STOP or CANCEL. The 
        SMS
         keyword can be in any locale.
      • action
        : Specifies the status of the action code. The following action codes used:
        • 1 check opt-in status
          : Displays the static information.
        • 2 opt-out
          : Unsubscribe from receiving alerts.
        • 3 opt-in
          : Subscribe to receive alerts.
        • 0 anything else
          : No other action.
      • datacoding
        : Specifies a character set for the response. For example, Latin (0), ASCII (1), or Unicode (8).
      • response
        : Specifies the message text that is returned to the user. The response message text must be the same locale as the 
        SMS
         keyword the user is trying to respond to.
  8. In the <accountConfig> section, update the following attribute values:
    • accountId
      : Account ID used to publish the alert.
    • accountThrottle
      : Displays the number of SMS messages sent to the gateway each second using the specified account.
    • responseMode
      : Specifies the mode the user can use to respond to the message. If the value to set to "reply" (default) user can respond using text message. If value is set to "link", user can respond using the link in the alert.
  9. Click 
    Update
    .