Multitech SF100-G-EU Specifications download pdf (Page 95)

Appendix A – Application Programming Interface (API)

95 MultiModem® iSMS System Administrator’s Guide

Sending a Job to a Slave MultiModem iSMS From Master MultiModem iSMS

You can use the TCP API to distribute the Job Load from Master MultiModem iSMS unit to a slave unit when load

balancing is enabled in the master and with the slaves properly configured.

TCP API format is:

/sendmsg?user=admin&passwd=admin&cat=4&enc=0&priority=2&to="+919844895691",”+16

675674532”&text=Here is the test message

The parameters are:

Parameter Description

cat 4

enc Encoding type of the SMS(Range 0 to 3)

0 - SMS text is in ASCII form

1 - SMS text is in Extended ASCII form

2 - SMS text is in hexadecimal form (i.e. each hexadecimal value is of 4 digits and each hexadecimal

value is separated by a semi-colon. Example: 0645;0041;0646).

3 - SMS text is in hexadecimal form. However, enc type is given as 3 to indicate to the slave to display in

decimal form as in the input send SMS job.

priority Priority of the SMS Job(Range 1 to 3)

1 - Low Priority

2 - Normal Priority

3 - High Priority

It indicates to the slave the priority of the job and to be handled accordingly.

to The mobile numbers where the SMS is to be delivered.

This number must be given in double quotes. The maximum size of each recipient’s number is 50 bytes

text The message text to be sent.

If enc is 0, SMS text is in ASCII.

If enc is 1, SMS text is in Extended ASCII.

If enc is 2 / 3 / 4, SMS text is in hexadecimal form.

Each hexadecimal value is of 4 digits and each hexadecimal value is separated by a semi-colon. Example:

0645;0041;0646)

Spanned SMS is sent as in the input Send SMS job.

Note:

An API request from master to slave contains only recipient’s numbers. Recipient names and groups are not

supported to make it independent of the Address Book in the slave.

Response from the Slave MultiModem iSMS After Receiving the Send SMS API from Master

MultiModem iSMS

The Slave MultiModem iSMS returns a unique identifier i.e., an API message ID for each "Send API request” and Load

Indicator, which tells the Job load on the slave.

This Load indicator is used to decide the least loaded slave while distributing to many slaves.

ID: apimsgid Load indicator

-or-

Err: error code Load indicator

1 2 ... 90 91 92 93 94 95 96 97 98 99 100 ... 125 126

Comments to this Manuals

No comments

Multitech SF100-G-EU Specifications Page 95

Comments to this Manuals

Related products and manuals for Gateways/controllers Multitech SF100-G-EU