Updated on 2023-10-12 GMT+08:00

Configuring SMS Gateways

Context

If the user password for connecting to the SMS gateway is changed, you need to modify the configuration in the AICC as follows: Choose Configuration Center > Access Configuration > Gateway Configuration, click Edit in the Operation column corresponding to the gateway to be modified, click the Message protocol parameters tab, and enter the new login password.

Procedure

  1. Sign in to the AICC as a tenant administrator and choose Configuration Center > Access Configuration > Gateway Configuration.
  2. Click New. On the Add Gateway Configuration page that is displayed, set gateway parameters.

    Figure 1 Setting gateway parameters
    • Gateway Name: Gateway name, which is customized.
    • Config Type: Set this parameter to SMS.
    • Protocol Type: Set this parameter to smpp.

  3. Click Next. On the Gateway Address Interconnection Configuration page,

    set gateway address interconnection parameters, including parameters in the Basic Configuration and Advanced Settings area. Parameters in the Basic Configuration area need to be manually set, and parameters in the Advanced Configuration area are set by default. You can set additional configuration items as required.

    • The configuration items that needed to set are displayed in the Basic Configuration area.
      Figure 2 Setting gateway address interconnection parameters
      Table 1 Parameters in the Basic Configuration area

      Parameter

      Description

      SMG Address

      This parameter is mandatory.

      IP address of the SMS gateway.

      Example: 10.10.10.10

      SMG Port

      This parameter is mandatory.

      Port number of the SMS gateway.

      Login Name

      Account for logging in to the gateway. This parameter is optional when the gateway simulator is used.

      Login Password

      Password for logging in to the gateway. This parameter is optional when the gateway simulator is used.

      Receiving And Sending Mode

      This parameter is mandatory.

      Whether a protocol device is used to send or receive SMS messages.

      Default value: Send and receive SMS messages. Value range:

      • Send and receive SMS messages: The protocol device is used to process messages received from the SMSC and send SMS messages.
      • Receive SMS messages: The protocol device is used to process messages received from the SMSC.
      • Send SMS Messages: The protocol device is used to send SMS messages.

      SMPP PDU Type

      This parameter is mandatory.

      Type of the SMPP PDU used for sending SMS messages.

      Default value: submit_sm. Value range:

      • submit_sm
      • data_sm

      Default Sending Number

      This parameter is mandatory.

      Number segment configured on the gateway for which SMS messages can be sent.

      Value range:

      • Letters
      • Digits
      • Special characters: plus signs (+) and hyphens (-)

      For example, if this parameter is set to 130, only the numbers starting with 130 can be used to send messages.

      Use semicolons (;) to separate multiple numbers.

      Default Receiving ID

      This parameter is mandatory.

      Number segment configured on the gateway for which SMS messages can be received.

      Value range:

      • Letters
      • Digits
      • Special characters: plus signs (+) and hyphens (-)

      For example, if this parameter is set to 130, only the numbers starting with 130 can be used to receive messages.

      Use semicolons (;) to separate multiple numbers.

    • The Advanced Settings area includes ESME Connection Configuration and Message protocol parameters, as shown in Figure 3. Parameters in this area are set by default and can be modified as required. Click OK.
      Figure 3 Advanced Settings under Gateway Address Interconnection Configuration
      Table 2 Parameters in the Advanced Settings area

      Parameter

      Description

      ESME Connection Configuration

      Client Port

      This parameter is mandatory.

      Number of an unoccupied port for the CC-Notification server. The port number is used to connect to the SMS gateway. If the client port needs to be specified for the SMS gateway, set this parameter.

      The default value is 0, indicating that the CC-Notification randomly allocates a port number. The value ranges from 0 to 65535.

      Port for receiving upstream messages

      Port number for receiving MO messages.

      The default value is 0, indicating that the value is automatically allocated by the CC-Notification. The value ranges from 0 to 65535.

      Heartbeat Interval(ms)

      Text box

      Interval for sending heartbeat messages to the SMS gateway to maintain the long connection between the CC-Notification and SMS gateway. This parameter specifies the interval for sending heartbeat messages.

      The default value is 30000, in milliseconds. The value is a number of 1 to 10 digits. The value must be greater than the value of Transaction Timeout Interval(ms) and less than the value of Receiving Timeout Interval(ms).

      Max Connection Times Upon No Heartbeat Response

      Text box

      Maximum number of consecutive heartbeat response failures. When this value is exceeded, the CC-Notification disconnects from the gateway.

      The value is a number of 0 to 5 digits.

      Enter

      The default value is 3.

      Resending Times

      Maximum number of resending times.

      The default value is 0. The value is a number of 0 to 10 digits.

      If the CC-Notification does not receive any heartbeat responses after sending a heartbeat message, the CC-Notification waits for a period of time (that is, the value of Resending Waiting Time(ms)) and then resends a heartbeat message.

      Resending Waiting Time(ms)

      Interval for resending an SMS message after the CC-Notification receives an SMS message sending failure response from the SMS gateway.

      The default value is 0. The value is a number of 0 to 10 digits.

      Receiving Timeout Interval(ms)

      This parameter is mandatory.

      Maximum duration for allowing no data transmission after an SMS device connects to the gateway. If the SMS device does not receive data from the peer device within this duration, automatic disconnection occurs.

      The default value is 180000. The value is a number of 1 to 10 digits and must be greater than the values of Heartbeat Interval(ms) and Transaction Timeout Interval(ms).

      To prevent ineffective connections, do not set this parameter to 0.

      Max Error Packets Received

      Number of error packets consecutively received by a device.

      The default value is 10. The value is a number of 0 to 10 digits.

      If this value is reached, the link is faulty and will be disconnected.

      Sliding Window Size

      This parameter is mandatory.

      Instantaneous concurrent processing capability of the CC-Notification.

      The default value is 16. Generally, set this parameter to a multiple of 16. The value is a number of 2 to 5 digits.

      This parameter is used to limit the number of messages sent by the CC-Notification, preventing errors that may occur on the SMSC due to great pressure.

      Transaction Timeout Interval(ms)

      Maximum duration for an SMS device to wait for a response from the peer device after sending a message. If the peer device does not respond within this duration, the SMS device does not wait any longer.

      The default value is 6000, in milliseconds. The value is a number of 0 to 10 digits. The value must be smaller than the values of Heartbeat Interval(ms) and Receiving Timeout Interval(ms).

      Max Message Length (bytes)

      This parameter is mandatory.

      Maximum message length specified by the protocol.

      The default value is 2048, in bytes. The value is a number of 1 to 5 digits.

      Oversized SMS Splitting Mode

      This parameter is mandatory.

      Mode of splitting an SMS message when the message content length exceeds the value of Max Content Length (bytes).

      The default value is disabled. Value range:

      • disabled: A long SMS message is not sent, and an exception is reported on the CC-Notification.
      • not split: The system directly sends an SMS message without checking whether it is too long.
      • physical splitting: A long SMS message is segmented into multiple independent SMS messages based on the value of Max Content Length(bytes).
      • ultra-long split: A long SMS message is split into several continuous SMS messages, that is, the system adds the combination control information to each sub-message. Terminals that support continuous SMS messages can combine the sub-messages into a complete SMS message.

      Max Content Length(bytes)

      This parameter is mandatory.

      Maximum message content length specified by the protocol. A long SMS message is split based on the value of this parameter.

      The default value is 140, in bytes. The value is a number of 1 to 5 digits.

      Min Sending Thread Pools

      This parameter is mandatory.

      Minimum number of threads that start in the thread pool when the protocol stack is used to send messages.

      The default value is 20. The value is a number of 1 to 5 digits.

      Max Sending Thread Pools

      This parameter is mandatory.

      Maximum number of threads that start in the thread pool when the protocol stack is used to send messages.

      The default value is 200. The value is a number of 1 to 5 digits.

      Sending Thread Pool Queue Length

      This parameter is mandatory.

      Length of the thread queue to be processed in the sending thread pool.

      The default value is 2000. The value is a number of 1 to 5 digits.

      Min Receiving Thread Pools

      This parameter is mandatory.

      Minimum number of state report receiving threads. Set this parameter by referring to the settings of the sending thread pool, but the values can be different.

      The default value is 20. The value is a number of 1 to 5 digits.

      Max Receiving Thread Pools

      This parameter is mandatory.

      Maximum number of state report receiving threads.

      The default value is 200. The value is a number of 1 to 5 digits.

      Receiving Thread Pool Queue Length

      This parameter is mandatory.

      State report receiving thread queue length.

      The default value is 2000. The value is a number of 1 to 5 digits.

      Max Receiving Rate

      Maximum rate at which messages are received using a protocol.

      Value range:

      • -
      • Positive integer

      If this parameter is empty, Max Sending Rate and Extra Traffic Processing Policy must be empty.

      Max Sending Rate

      Maximum rate at which messages are sent using a protocol.

      Value range:

      • -
      • Positive integer

      If this parameter is empty, Max Receiving Rate and Extra Traffic Processing Policy must be empty.

      Extra Traffic Processing Policy

      Policy for sending messages when the traffic exceeds the threshold.

      Value range:

      • -
      • Positive integer

      If this parameter is empty, Max Receiving Rate and Max Sending Rate must be empty.

      Long Message Concatenation Mode

      This parameter is mandatory.

      Mode of combining long SMS messages.

      The default value is GSM User Data Header. Value range:

      • GSM User Data Header
      • SMPP parameters

      Message protocol parameters

      ESME Type

      External short message entity (ESME) type.

      The value can contain a maximum of 13 characters.

      For details, see the description of the system_type field in the bind message of the SMPP protocol.

      ESME Address Type Code

      Address type ID of the extended SMS message entity.

      The value is a positive integer from 1 to 28.

      For details, see the description of the addr_ton field in the bind message of the SMPP protocol.

      ESME Address Encoding Mode

      Address encoding mode of the extended SMS message entity.

      The value is a string of 0 to 10 digits.

      For details, see the description of the addr_npi field in the bind message of the SMPP protocol.

      ESME Address Range

      Address encoding mode of the extended SMS message entity.

      The value is a string of 1 to 15 characters.

      For details, see the description of the address_range field in the bind message of the SMPP protocol.

      Service Type

      Type of the SMS application service specified by the gateway.

      The value is a string of 1 to 500 characters.

      For details, see the description of the service_type field in the submit_sm/data_sm message of the SMPP protocol.

      Source Address Code Type

      This parameter is mandatory.

      Type of the code in the source address in SMPP SubmitMessage.

      The default value is 0. The value is a number of 1 to 10 digits.

      For details, see the description of the source_addr_ton field in the submit_sm/data_sm message of the SMPP protocol.

      Source Address Code Scheme

      This parameter is mandatory.

      Scheme of the code in the source address in SMPP SubmitMessage.

      The default value is 0. The value is a number of 1 to 10 digits.

      For details, see the description of the source_addr_npi field in the submit_sm/data_sm message of the SMPP protocol.

      Destination Address Code Type

      This parameter is mandatory.

      Type of the code in the destination address in SMPP SubmitMessage.

      The default value is 0. The value is a number of 1 to 10 digits.

      For details, see the description of the dest_addr_ton field in the submit_sm/data_sm message of the SMPP protocol.

      Destination Address Code Scheme

      This parameter is mandatory.

      Scheme of the code in the destination address in SMPP SubmitMessage.

      The default value is 0. The value is a number of 1 to 10 digits.

      For details, see the description of the dest_addr_npi field in the submit_sm/data_sm message of the SMPP protocol.

      Message Type

      This parameter is mandatory.

      Message type.

      The default value is 0. The value is a number of 1 to 10 digits.

      For details, see the description of the esm_class field in the submit_sm/data_sm message of the SMPP protocol.

      Message Format

      This parameter is mandatory.

      SMS message encoding mode.

      The default value is ASCII string. Value range:

      • ASCII string: ASCII string in which one character occupies one byte
      • binary information
      • UCS2 encoding: UCS2 code (ISO/IEC-10646) in which one character occupies two bytes

      Protocol ID

      This parameter is mandatory.

      GSM protocol ID.

      The default value is 0. The value is a number of 1 to 10 digits.

      For details, see the description of the data_coding field in the submit_sm message of the SMPP protocol.

      Return Status Confirmation Report

      This parameter is mandatory.

      State reports to be returned.

      The default value is 2. Value range:

      • 0: No status report is received.
      • 1: Success and failure state reports are returned.
      • 2: Failure state reports are returned.

      Replacement Flag

      This parameter is mandatory.

      Whether to replace the existing SMS messages whose source addresses and destination addresses are the same.

      The default value is Not replace. Value range:

      • Not replace
      • Replace

      Default Message ID

      This parameter is mandatory.

      ID of a predefined SMS message. It is the index of a predefined SM created by the administrator of the message center.

      The default value is 0. The value can contain a maximum of 500 characters.

      For details, see the description of the sm_default_msg_id field in the submit_sm message of the SMPP protocol.

  4. Click OK to complete the SMS gateway configuration.

Follow-up Procedure

  • Re-create a gateway.
    1. Choose Configuration Center > System Management > Gateway Monitoring.
    2. Click Rebuilding.
  • Disconnect a gateway that fails to be connected.
    1. Choose Configuration Center > System Management > Gateway Monitoring.
    2. Click Disconnected.