Multitech MultiModem iSMS SF 100-G User Manual For System Administrators page 93

Sending a Job to a Slave MultiModem iSMS From Master MultiModem iSMS
TCP API is also used 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="+9198448956
91","+16675674532"&text=Here is the test message
The parameters are:
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
e.g.,
ID: 1 1
Err 608 1000
Multi-Tech Systems, Inc.
Downloaded from Elcodis.com electronic components distributor
•
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 has to be given within 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.
(i.e. each hexadecimal value is of 4 digits and each hexadecimal value is separated
by a semi-colon. Example: 0645;0041;0646)
Spanned SMS would be sent as in the input Send SMS job.
Note: An API request from master to slave will contain only recipient's numbers. Recipient
names and groups are not supported to make it independent of the Address Book in the
slave.
MultiModem® iSMS User Guide for Administrators
Appendix A – Application Programming Interface (API)
93