Appendix A – Application Programming Interface (API)
Multi-Tech Systems, Inc. MultiModem® iSMS User Guide for Administrators 77
Authentication
The system needs to authenticate any API request. We achieve this by having the authentication
credentials as part of the "Send SMS URL" or “Send SMS TCP” command.
user - The username of the account, which has a maximum of 50 bytes.
passwd - The password of the account, which has a maximum of 50 bytes.
This user should be Admin or the configured Send Users.
Every "Send SMS URL" should have the username and password, and every request is authenticated by
the MultiModem iSMS.
Sending to a Number
HTTP API format is:
http://192.168.2.1[:portnumber]/sendmsg?user=user1&passwd=puser1&cat=1[
&enc=0][&priority=1][&modem=1]&to=”7657867765”&text=message
The parameters are:
• cat Category
1 - Send SMS
2 - Broadcast Trigger
3 - Action Trigger
• enc Encoding type to send SMS(Optional field)
Range: 0 to 3
0 - SMS text should be in ASCII form
1 - SMS text should be in Extended ASCII form
2 - SMS text should be in hexadecimal form (i.e. each hexadecimal value length
should be maximum 4 and each hexadecimal value should be separated by a
semi-colon. Example: 0645;41;646)
3 - SMS text should be in decimal form (i.e. each decimal Value length should
be maximum 5 and each decimal value should be separated by a semi-colon.
Example: 1605;65;65300) Note:
Maximum decimal value allowed is 65535
If enc is not specified in the send API request, default enc will be the configured
settings in SMS settings page .
i.e. enc=2, if Unicode is enabled.
enc=1, if Extended ASCII is enabled.
enc=0, if both Extended ASCII and Unicode are disabled.
• priority Priority to send SMS (Optional field)
Range: 1 to 3
1 - Low Priority
2 - Normal Priority
3 - High Priority
If priority is not specified in the request, default priority is normal.
Downloaded from Elcodis.com electronic components distributor
To Next Page
Loading...
