Configuration

API Interface: SMPP API Version 3.4

SMPP Bind Role and Mode

For SMPP API connections, Aerialink supports both the ESME and SMSC roles as well as all three operation types; transmitter, receiver, and transceiver modes. If you would like to connect as the SMSC role, please contact our customer support to obtain approval.

SMPP Bind Configuration

Your SMPP connection will maintain a socket connection to our network. The following bind configuration is recommended for your ESME.

Account Configuration Settings

Refer to your account for the following configuration values:

  • Host IP: This is the Aerialink SMSC Host Address
  • Host Port: This is the Aerialink SMSC Host Port
  • System Identifier: The username for your SMPP bind connection
  • Password: The password for your SMPP bind connection

General Configuration Settings:

System Type

The system type is typically used to access unique or proprietary features of an SMSC. The default setting of “SMPP” can be used for the Aerialink network, however it is not currently required for your bind.

  • system-type=SMPP

The address range for your ESME client

These values will tell your EMSE what format to process the message addressing as on the bind level. The recommended settings are “1” for both the TON and NPI. The address range is typically optional unless your EMSE requires it.
addr-ton=1
addr-npi=1
address-range=[optional]

Source Address for your ESME client

  • source-ton=[X]
  • source-npi=[Y]
    If the TON and NPI are not provided in your submit, the default for your account and code (Short Code, Long Code, Alphanumeric Code) will be used.

Source address for each SMS Submit

This value should match one of your provisioned Short Codes, Long Codes, or Alphanumeric Codes. For Long Codes the value should be set to the fully qualified Long Code which includes the Country Code, but without the +. Example: For Short Code “1234”, for Long Code “13105551212”, or for an Alphanumeric Code “AERIALINK” (This is an example only. Do not use these values in your configuration.)

  • source-address=[1xxxYYYzzzz]

Address Range

This is the address range that your ESME client serves in yoru application. These values will tell your EMSE what format to process the message addressing as on the bind level. The recommended settings are “1” for both the TON and NPI. The address range is typically optional unless your EMSE requires it.
addr-ton=1
addr-npi=1
address-range=[optional]

Destination Address

The TON and NPI should be set to a value of “1” each.

  • destination-ton=1
  • destination-npi=1
  • destination-address=[1xxxYYYzzzz]
    The destination address should always be in full international format excluding the plus sign. Example “13105551212” (This is an example only. Do not use this values in your configuration.)

Transaction Timeout

  • Transaction Timeout: 60
  • Idle Timeout: 0
  • Keep Alive Timeout: 45
  • Number Transceiver Connection: 1

Message Send Rate

This is how many messages per second your gateway is allowed to send. Aerialink imposes strict limits on SMPP bind throughput and depending on the communication code; Short Code, Long Code, or Alphanumeric Code there are strict limits imposed by Operators/Carriers which Aerialink will aggresively enforce. Please see Throughput Limits for more information. If you require additional throughput, please contact Aerialink Customer Support with your request for consideration.

  • message-rate=10

Synchronous or Asynchronous Mode

Aerialink supports both Synchronous or Asynchronous ESME Modes. If your ESME is set to “synchronous” mode, yoru ESME will wait for the response from the Aerialink SMSC server when sending a message. Asynchronous mode will not. We recommend you run your ESME in Synchronous mode.

  • mode=synchronous

Network Retry on Error

Your ESME should not retry a submit when there is a network error. Instead the issue should be addressed on the bind level to determine what the cause is for the network error.

Transient Retry on Errors

Your ESME should not retry a submit when there is a network error. Instead the issue should be addressed on the bind level to determine what the cause is for the network error.

TON and NPI Description

For a summary on the TON and NPI settings, see TON and NPI Settings.

Receive Timeout

The amount of time your ESME should wait while receiving a message
receive-timeout=20

This is how often your ESME will send the EnquireLink PDU to the Aerialink SMSC to verify that the connection is still healthy. Aerialink recommends this be set to 60 seconds.
ping-interval=60

Connection Attempts

This is the number of connection attempts your ESME will make until it gives up. This should be set to a reasonable number but not an infinite account. If you have a server that is unable to negotiate a connection but continues to try infinately you will risk your IP address or Subnet being black listed by the Aerialink firewall.
retries=[Customer Defined Value, Not Infinite]

Connection Retry Interval

This setting specifies how long your ESME will wait in between each connection attempt. Aerialink recommends 900 seconds which is 15 minutes. This will allow any temporary network issues to subside. Continued failues should be escalated to the Aerialink Support Team for assistance.
retry-interval=900

SMPP Bind Configuration Cache

At the point your bind is established your connection will cache both your provisioned Short Codes, Long Codes, Throughput Allowance, and your Routing details. Any changes to this configuration will require a rebind.

SMPP Official Specification

For details on the SMPP Specification, see SMPP 3.4 Official Specification.

Troubleshooting

If you are having trouble authenticating with the Aerialink API confirm that you have white listed your IP address and that your API credentials are correct. You can view the API Authentication Error Log under Reports in the APi section of the Platform portal. This will confirm whether your authentication requests are being rejected or not.

Support

If you require any additional assistance, please use one of these methods to contact the Aerialink Support Team.

This page was last updated 1515185923000