Configuring SMS Gateways

A tenant administrator can configure SMS gateways to send and receive SMS messages.

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

Sign in to the AICC as a tenant administrator and choose Configuration Center > Access Configuration > Gateway Configuration.

Figure 1 Gateway Configuration
Click New. The Create Gateway page is displayed.

Figure 2 Create Gateway - Basic Information
After basic information is configured, click Next. The Gateway Address Interconnection Configuration page is displayed.
- Basic Configuration: Parameters in this area are mandatory.
  Figure 3 Gateway Address Interconnection Configuration - Basic Configuration
  - SMG Address (mandatory): IP address of the SMS gateway, for example, 10.10.10.10.
  - SMG Port (mandatory): Port number of the SMS gateway.
  - Login Name: Account for logging in to the gateway. This parameter is optional when a gateway simulator is used.
  - Login Password: Password for logging in to the gateway. This parameter is optional when a gateway simulator is used.
  - Receiving And Sending Mode (mandatory): Whether the protocol device is used to send or receive SMS messages. The default value is Send and receive SMS messages. The options are as follows:
    - 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 (mandatory): Type of the SMPP PDU used for sending SMS messages. The default value is submit_sm. The options are as follows:
    - submit_sm
    - data_sm
  - Prefix of the sender number (mandatory): Prefix of the number segment configured on the gateway for which SMS messages can be sent. The value can contain only letters, digits, plus signs (+), and minus signs (-).
    For example, if this parameter is set to 130, the options of Default Sending Number are sender numbers starting with 130. Multiple numbers are separated by semicolons (;).
  - Accepted Number Prefix (mandatory): Prefix of the number segment configured on the gateway for which SMS messages can be received. The value can contain only letters, digits, plus signs (+), and minus signs (-).
    For example, if this parameter is set to 130, the options of Default Sending Number are sender numbers starting with 130. Multiple numbers are separated by semicolons (;).
  - Default Sender Number: Default sender number of the gateway. The value can contain only letters, digits, plus signs (+), and minus signs (-).
- ESME Connection Configuration: Parameters in this area are set by default and can be modified as required.
  Figure 4 Gateway Address Interconnection Configuration - ESME Connection Configuration
  - Client Port (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 value ranges from 0 to 65535.
    The default value is 0, indicating that the CC-Notification randomly allocates a port number.
  - Port for receiving upstream messages: Port number for receiving MO messages. The value ranges from 0 to 65535.
    The default value is 0, indicating that the CC-Notification automatically allocates a port number.
  - Heartbeat Interval(ms): Interval for sending heartbeat messages to the SMS gateway to maintain the persistent connection between the CC-Notification and SMS gateway. This parameter specifies the interval for sending heartbeat messages. The value is a number of 1 to 10 digits. The value must be greater than that of Transaction Timeout Interval(ms) and less than that of Receiving Timeout Interval(ms).
    The default value is 30000, in milliseconds.
  - Max Connection Times Upon No Heartbeat Response: 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.
    The default value is 3.
  - Resending Times: Maximum number of resending times. After the CC-Notification sends a heartbeat message, if the CC-Notification does not receive a heartbeat response within the transaction timeout interval, the CC-Notification waits for a period of time (specified by Resending Waiting Time(ms)) and then resends the heartbeat message. The value is a number of 0 to 10 digits.
    The default value is 0.
  - 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 value is a number of 0 to 10 digits.
    
    The default value is 0.
  - Receiving Timeout Interval(ms) (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 value is a number of 1 to 10 digits. The value must be greater than those of Heartbeat Interval(ms) and Transaction Timeout Interval(ms). To prevent invalid connections, do not set this parameter to 0.
    The default value is 180000.
  - Max Error Packets Received: Number of error packets consecutively received by a device. If this value is reached, the link is faulty and will be disconnected. The value is a number of 0 to 10 digits.
    The default value is 10.
  - Sliding Window Size (mandatory): Instantaneous concurrent processing capability of the CC-Notification. 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. The value is a number of 2 to 5 digits.
    The default value is 16. Generally, set this parameter to a multiple of 16.
  - 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 value is a number of 0 to 10 digits. The value must be less than those of Heartbeat Interval(ms) and Receiving Timeout Interval(ms).
    The default value is 6000, in milliseconds.
  - Max Message Length (bytes) (mandatory): Maximum message length specified by the protocol. The value is a number of 1 to 5 digits.
    The default value is 2048, in bytes.
  - Oversized SMS Splitting Mode (mandatory): Mode of splitting an SMS message when the message content length exceeds the value of Max Content Length (bytes). The options are as follows:
    - 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.
    The default value is disabled.
  - Max Content Length(bytes) (mandatory): Maximum message content length specified by the protocol. A long SMS message is split based on the value of this parameter. The value is a number of 1 to 5 digits.
    The default value is 140, in bytes.
  - Min Sending Thread Pools (mandatory): Minimum number of threads that start in the thread pool when the protocol stack is used to send messages. The value is a number of 1 to 5 digits.
    The default value is 20.
  - Max Sending Thread Pools (mandatory): Maximum number of threads that start in the thread pool when the protocol stack is used to send messages. The value is a number of 1 to 5 digits.
    The default value is 200.
  - Sending Thread Pool Queue Length (mandatory): Length of the thread queue to be processed in the sending thread pool. The value is a number of 1 to 5 digits.
    The default value is 2000.
  - Min Receiving Thread Pools (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 value is a number of 1 to 5 digits.
    The default value is 20.
  - Max Receiving Thread Pools (mandatory): Maximum number of state report receiving threads. The value is a number of 1 to 5 digits.
    The default value is 200.
  - Receiving Thread Pool Queue Length (mandatory): State report receiving thread queue length. The value is a number of 1 to 5 digits.
    The default value is 2000.
  - Max Receiving Rate: Maximum rate at which messages are received using a protocol. The value can be empty or a positive integer. If the value is empty, the values of Max Sending Rate and Extra Traffic Processing Policy must also be empty.
  - Max Sending Rate: Maximum rate at which messages are sent using a protocol. The value can be empty or a positive integer. If the value is empty, the values of Max Receiving Rate and Extra Traffic Processing Policy must also be empty.
  - Extra Traffic Processing Policy: Policy for sending messages when the traffic exceeds the threshold. The value can be empty or a positive integer. If the value is empty, the values of Max Receiving Rate and Max Sending Rate must also be empty.
  - Long Message Concatenation Mode (mandatory): Mode of combining long SMS messages. The options are GSM User Data Header and SMPP parameters.
    The default value is GSM User Data Header.
- Message protocol parameters: Parameters in this area are set by default and can be modified as required.
  Figure 5 Gateway Address Interconnection Configuration - 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 less than 2⁸.
    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 number 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 can contain a maximum of 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 can contain a maximum of 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 (mandatory): Type of the code in the source address in SMPP SubmitMessage. The value is a number of 1 to 10 digits.
    The default value is 0. 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 (mandatory): Scheme of the code in the source address in SMPP SubmitMessage. The value is a number of 1 to 10 digits.
    The default value is 0. 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 (mandatory): Type of the code in the destination address in SMPP SubmitMessage. The value is a number of 1 to 10 digits.
    The default value is 0. 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 (mandatory): Scheme of the code in the destination address in SMPP SubmitMessage. The value is a number of 1 to 10 digits.
    The default value is 0. For details, see the description of the dest_addr_npi field in the submit_sm/data_sm message of the SMPP protocol.
  - Message Type (mandatory): Message type. The value is a number of 1 to 10 digits.
    The default value is 0. For details, see the description of the esm_class field in the submit_sm/data_sm message of the SMPP protocol.
  - Message Format (mandatory): SMS message encoding mode. The options are as follows:
    - ASCII string: ASCII string in which one character occupies one byte
    - binary information
    - UCS2 encoding: ISO/IEC-10646 in which one character occupies two bytes
    The default value is ASCII string.
  - Protocol ID (mandatory): GSM protocol ID. The value is a number of 1 to 10 digits.
    The default value is 0. For details, see the description of the data_coding field in the submit_sm message of the SMPP protocol.
  - Return Status Confirmation Report (mandatory): State reports to be returned. The options are as follows:
    - 0: No state report is received.
    - 1: Success and failure state reports are returned.
    - 2: Failure state reports are returned.
    The default value is 2.
  - Replacement Flag (mandatory): Whether to replace the existing SMS messages whose source addresses and destination addresses are the same. The options are Not replace and Replace.
    The default value is Not replace.
  - Default Message ID (mandatory): ID of a predefined SMS message. It is the index of a predefined SMS message created by the administrator of the message center. The value can contain a maximum of 500 characters.
    The default value is 0. For details, see the description of the sm_default_msg_id field in the submit_sm message of the SMPP protocol.
After gateway interconnection information is configured, click Save.

Follow-up Procedure

Rebuild 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.