smsprogateway Hypermedia SMS PRO gateway

<< Click to Display Table of Contents >>

Navigation:  Reference > Gateway properties >

smsprogateway Hypermedia SMS PRO gateway

Only available in Diafaan SMS Server - basic and full editions.

 

SMS PRO Gateway properties


Host or IP number

Enter the host name or IP number of the Hypermedia SMS PRO gateway.

 

Server port

The port number of the Hypermedia SMS PRO gateway. Port number 63333 is the default port for the device.

 

Client ID

A unique Client ID (user name), the Client ID can be freely chosen by the user. If another client logs in with the same ID as an existing client then the new client will cause the disconnection of the old client and a message will be sent to each indicating this, therefore it is recommended that each new client that connects to the gateway should use a unique ID. Note that if no ID is given, a unique ID will be generated for the client by the gateway.

 

Password

The password of the Hypermedia SMS PRO gateway.

 

 

SIM card routing properties


Use all SIM cards in the SMS PRO Gateway

Use all SIM cards in the SMS PRO Gateway to send and receive SMS messages.

 

Use SIM cards:

Enter a list with all SIM cards in the Hypermedia SMS PRO Gateway you want to use to send and receive SMS messages. Click the Update button to refresh the available SIM card list. The SIM card list may contain multiple SIM cards separated by semicolons, e.g. <21#1>;<21#2>

 

You can assign a GSM number to each SIM card that is inserted in the To field of received messages, e.g. +11111111111 <21#1>;+22222222222 <21#2>

 

 

Advanced properties


LogCommunicationToFile

Log all internet communication to file. Use this option only if you encounter problems with the connection to your SMPP account. If enabled, the status windows of the SMPP gateway provides a link to the location on you hard disk where the file is stored.

 

MaximumBatchSize

The maximum number of messages this gateway will process in one batch. If this value is higher than one and a number of messages are sent at the same time, the gateway loads multiple messages concurrently. This increases the speed in which the messages are sent.

 

NumberTemplate

The number template can be used to translate the number from one format to another.

 

For more information see Use number templates.

 

NumberWhiteList

List of allowed mobile numbers for received SMS messages, messages from other numbers are blocked. When the list does not have any items received SMS messages from all numbers are allowed.

 

For more information about the white list and black list format see: Use white lists and black lists.

 

QuietHours

A list of 24 hour numbers (separated with semicolons) when sending messages with this gateway is paused. The hour number can be appended with .1, .2, .3 or .4 to specify the first, second, third or fourth quarter of the hour. If the messages cannot be sent with another gateway, they stay in the send queue until the quiet hours are over and this gateway resumes message sending.

00;01;23 pauses message sending from 23:00:00 to 01:59:59.

12.1;12.2;18.1;18.2 pauses message sending from 12:00:00 to 12:29:59 and from 18:00:00 to 18:29:59.

 

EnableHTTPCallbacks

Enable or disable HTTP callbacks for this gateway. This option is only available when the HTTP callback option is enabled in the general options.

 

DeliveryConfirmation

Require status updates for the SMS messages after it is sent to the SMSC. If you do not need to know if the SMS messages are delivered on the GSM phone or if the status updates causes errors sending the messages you can disable status updates.

 

MaxMessageParts

Messages to send that are longer than 160 characters or 70 characters for unicode messages can be split in multiple SMS messages that are recombined to one message on the handset of the receiver. The MaxMessagePart property limits the amount of partial messages that the gateway sends with a long message. If the message is longer than can be sent with the maximum message parts, the rest of the message is discarded.

 

MessageType

The message type is the default value for the SMS message encoding, the default value may be replaced with the message type specified by the sending Connector.

The gateway uses four possible value for the default message type:

 

Automatic

Standard Text encoding is the default, Unicode encoding will be used only if the message contains characters that are not in the default GSM SMS character set.

StandardText

The default 7-bit GSM SMS character set is used, all other characters are converted to question marks.

Unicode

All messages are sent in Unicode 16-bit encoding.

Data

All messages are sent in binary 8-bit encoding.

 

The GSM Modem gateway supports the following custom message types:

 

sms.automatic

Standard Text encoding is the default, Unicode encoding will be used only if the message contains characters that are not in the default GSM SMS character set.

sms.text

The default 7-bit GSM SMS character set is used, all other characters are converted to question marks.

sms.unicode

The message is sent in Unicode 16-bit encoding.

sms.binary

The message is sent in binary 8-bit encoding.

sms.automatic.flash

Flash SMS, standard Text encoding is the default, Unicode encoding will be used only if the message contains characters that are not in the default GSM SMS character set.

sms.text.flash

Flash SMS, the default 7-bit GSM SMS character set is used, all other characters are converted to question marks.

sms.unicode.flash

Flash SMS, all messages are sent in Unicode 16-bit encoding.

 

ValidityPeriod

The validity period of sent messages, specified in number of days (1-30) or as hexadecimal value (0x00-0xFF).

 

The hexadecimal values translate to the following validity period (Value is the decimal value):

 

0x00 - 0x8F

(Value + 1) x 5 minutes (i.e. 5 minutes intervals up to 12 hours)

0x90 - 0xA7

12 hours + ((Value -143) x 30 minutes)

0xA8 - 0xC4

(Value - 166) x 1 day

0xC5 - 0xFF

(Value - 192) x 1 week

 

AdditionalMessageParameters

List of additional Hypermedia SMS PRO API message parameters, separated by semicolons. The parameter consists of a parameter name and a value, separated by a colon (':'). The value is a hexadecimal encoded representation of the information, for example  '1' must be encoded as '31' and 'abcd' must be encoded as '61626364'.

 

Examples:

 

Set priority to 1:

priority:31

 

Set queue type to 'master':

queue_type:6d6173746572

 

Set both options:

priority:31;queue_type:6d6173746572