{"id":290,"date":"2010-02-24T11:50:46","date_gmt":"2010-02-24T17:50:46","guid":{"rendered":"http:\/\/dmartenson.dc.multitech.prv\/developer\/?page_id=290"},"modified":"2010-04-01T13:07:51","modified_gmt":"2010-04-01T18:07:51","slug":"isms-send-api","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/isms\/isms-send-api\/","title":{"rendered":"iSMS Send API"},"content":{"rendered":"<p><strong>HTTP Send API Format<\/strong><\/p>\n<p>Each &#8220;HTTP Send API Request&#8221; consists of four parts:<br \/>\n\u2022 The first part is the destination; i.e., the MultiModem iSMS IP and HTTP port number.<br \/>\n\u2022 The second part is the API call which is the query; therefore, it has a &#8216;?&#8217; post-fixed to the call.<br \/>\n\u2022 The third part is for authentication, which is in the form of a username and password.<br \/>\n\u2022 The fourth part is the message parameters.<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=puser1&amp;cat=1&amp;to=\"7637175845\"&amp;text=message<\/code><\/p>\n<p>Where, portnumber is optional and<\/p>\n<p>user1,puser1, 7637175845 and message are variable\/configured parameters.<\/p>\n<p>When HTTP Send API is enabled, it is also possible to send SMS from a non-browser with a TCP connection to the configured HTTP Port by following the steps below:<br \/>\n\u2022 Initiate a raw TCP connection to the MultiModem iSMS IP address over the &#8220;HTTP Send API&#8221; port<br \/>\nExample : telnet 192.168.2.1 81<br \/>\n\u2022 Issue GET command to send SMS.<br \/>\n\u2022 Issue GET command to query the status of send SMS.<\/p>\n<p>Send API Format<\/p>\n<p><code>GET \/sendmsg?user=admin&amp;passwd=admin&amp;cat=1[&amp;enc=0][&amp;priority=1][&amp;modem=2]&amp;to=5645676543&amp;ton=Graham&amp;group=Engineering&amp;text=This%20is%20a%20test%20m<br \/>\nessage.^M^J<\/code><\/p>\n<p>Or<\/p>\n<p><code>GET \/sendmsg?user=admin&amp;passwd=admin&amp;cat=1[&amp;enc=1][&amp;priority=2][&amp;modem=0]&amp;to=%225678976543%22&amp;ton=%22Bob%22&amp;group=%22Engineering%22&amp;text=This%20is%20a%20test%20message.^M^J<\/code><\/p>\n<p>Query API Format<\/p>\n<p><code>GET \/querymsg?user=admin&amp;passwd=admin&amp;apimsgid=message id.^M^J<\/code><\/p>\n<p>Note: All special characters must be given in URL encoded format with hex value; e.g., space should be given as %20; double quotes should be given as %22.<br \/>\nExample: If a name is Graham Bell, it should be given as Graham%20Bell<\/p>\n<p>Authentication<\/p>\n<p>The system needs to authenticate any API request. We achieve this by having the authentication credentials as part of the &#8220;Send SMS URL&#8221; or \u201cSend SMS TCP\u201d command.<br \/>\nuser &#8211; The username of the account, which has a maximum of 50 bytes.<br \/>\npasswd &#8211; The password of the account, which has a maximum of 50 bytes.<br \/>\nThis user should be Admin or the configured Send Users.<br \/>\nEvery &#8220;Send SMS URL&#8221; should have the username and password, and every request is authenticated by the MultiModem iSMS.<\/p>\n<p>Sending to a Number<\/p>\n<p>HTTP API format is:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=puser1&amp;cat=1[<br \/>\n&amp;enc=0][&amp;priority=1][&amp;modem=1]&amp;to=\u201d7657867765\u201d&amp;text=message<br \/>\n<\/code><\/p>\n<p>The parameters are:<\/p>\n<p>\u2022 cat Category<br \/>\n1 &#8211; Send SMS<br \/>\n2 &#8211; Broadcast Trigger<br \/>\n3 &#8211; Action Trigger<\/p>\n<p>\u2022 enc Encoding type to send SMS(Optional field)<br \/>\nRange: 0 to 3<br \/>\n0 &#8211; SMS text should be in ASCII form<br \/>\n1 &#8211; SMS text should be in Extended ASCII form<br \/>\n2 &#8211; SMS text should be in hexadecimal form (i.e. each hexadecimal value length<br \/>\nshould be maximum 4 and each hexadecimal value should be separated by a semi-colon. Example: 0645;41;646)<br \/>\n3 &#8211; 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.<br \/>\nExample: 1605;65;65300) Note: Maximum decimal value allowed is 65535<br \/>\nIf enc is not specified in the send API request, default enc will be the configured<br \/>\nsettings in SMS settings page .<br \/>\ni.e. enc=2, if Unicode is enabled.<br \/>\nenc=1, if Extended ASCII is enabled.<br \/>\nenc=0, if both Extended ASCII and Unicode are disabled.<\/p>\n<p>\u2022 priority Priority to send SMS (Optional field)<br \/>\nRange: 1 to 3<br \/>\n1 &#8211; Low Priority<br \/>\n2 &#8211; Normal Priority<br \/>\n3 &#8211; High Priority<br \/>\nIf priority is not specified in the request, default priority is normal.<\/p>\n<p>\u2022 modem Modem index to send SMS (this is only for the SF 400\/800 models)<br \/>\nRange : 1 to 4 for SF 400<br \/>\n1 to 8 for SF 800<\/p>\n<p>0 for any modem (Send API job will be distributed via all the available modems)<br \/>\nIf modem is not specified in the request, send API job will be distributed via all the<br \/>\navailable modems.<br \/>\n\u2022 to The mobile number where the SMS is to be delivered.<br \/>\nThis number has to be given within double quotes. The maximum size of each<br \/>\nrecipient\u2019s number is 50 bytes.<br \/>\n\u2022 text The message text to be sent.<br \/>\nEnable Extended ASCII in the MultiModem iSMS to send both ASCII and extended ASCII characters. By default, Extended ASCII is disabled and the message could have only ASCII characters.<br \/>\nNotes: If Extended ASCII and Unicode are disabled and spanned SMS value is 1, a maximum of 160 characters can be sent.<br \/>\nIf Extended ASCII is enabled and spanned SMS value is 1, a maximum of 140 characters can be sent.<br \/>\nIf Unicode is enabled and spanned SMS value is 1, a maximum of 70 characters can be sent.<br \/>\nIf the spanned SMS value is more than 1, the maximum number of characters allowed for each encoding scheme is defined as follows (where n represents the span value):<br \/>\nASCII \u2013 n * 154 characters<br \/>\nExtended ASCII \u2013 n * 134 characters<br \/>\nUnicode \u2013 n * 64 characters<br \/>\nAny characters entered beyond the allowed limit will be chopped off.<br \/>\nIn the HTTP API format example above: user1, puser1, 7657867765 and message are variables \/ configured parameters.<\/p>\n<p>Sending to an Address Book Name<\/p>\n<p>The API can be used to send the message to a name in the MultiModem iSMS address book. If the name does not exist in the address book, the message is dropped.<\/p>\n<p>HTTP API format is:<br \/>\n<code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=1<br \/>\n[&amp;enc=0][priority=3][&amp;modem=2]&amp;ton=\u201dbob\u201d&amp;text=message<br \/>\n<\/code><\/p>\n<p>or<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=1<br \/>\n[&amp;enc=2][priority=3][&amp;modem=2]&amp;ton=\u201dbob\u201d&amp;text=41;42;645;0645(hexadecimal form)<br \/>\n<\/code><br \/>\nor<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=1<br \/>\n[&amp;enc=3][priority=3][&amp;modem=2]&amp;ton=\u201dbob\u201d&amp;text=65;66;67(decimal form)<\/code><\/p>\n<p>The parameters are:<br \/>\n\u2022 cat 1<br \/>\n\u2022 enc Encoding type to send SMS(Optional field)<br \/>\nRange: 0 to 3<br \/>\n0 &#8211; SMS text should be in ASCII form<br \/>\n1 &#8211; SMS text should be in Extended ASCII form<br \/>\n2 &#8211; SMS text should be in hexadecimal form (i.e. each hexadecimal value length<br \/>\nshould be maximum 4, and each hexadecimal value should be separated by<br \/>\na semi-colon. Example: 0645;41;646)<br \/>\n3 &#8211; SMS text should be entered in decimal form (i.e. each decimal Value length<br \/>\nshould be maximum 5, and each decimal value should be separated by a<br \/>\nsemi-colon. Example: 1605;65;65300)<br \/>\nNote: Maximum decimal value allowed is 65535.<\/p>\n<p>If enc is not specified in the send API request, default enc will be the configured<br \/>\nsettings in SMS settings page.<br \/>\ni.e. enc=2, if Unicode is enabled.<br \/>\nenc=1, if Extended ASCII is enabled.<br \/>\nenc=0, if both Extended ASCII and Unicode are disabled.<\/p>\n<p>\u2022 Priority Priority to send SMS(Optional field)<br \/>\nRange: 1 to 3<br \/>\n1 &#8211; Low Priority<br \/>\n2 &#8211; Normal Priority<br \/>\n3 &#8211; High Priority<br \/>\nIf priority is not specified in the request, the default priority is normal.<\/p>\n<p>\u2022 modem Modem index to send SMS (this is only for the SF 400\/800 models)<br \/>\nRange : 1 to 4 for SF 400<br \/>\n1 to 8 for SF 800<br \/>\n0 for any modem (Send API job will be distributed via all the available<br \/>\nmodems)<br \/>\nIf modem is not specified in the request, send API job will be distributed via all the<br \/>\navailable modems<br \/>\n\u2022 ton The name in the address book where the SMS is to be delivered must be given within<br \/>\ndouble quotes. The maximum size of each recipient&#8217;s name is 50 bytes.<br \/>\n\u2022 text The message text to be sent.<br \/>\nEnable Extended ASCII in the MultiModem iSMS to send both ASCII and extended<br \/>\nASCII characters. By default, Extended ASCII is disabled and the message can have only ASCII characters.<br \/>\nIf Unicode is enabled(if enc is not specified in request), SMS text should be only in Hexadecimal form.<br \/>\nIf Extended ASCII and Unicode are disabled and spanned SMS value is 1, a maximum of 160 characters can be sent.<br \/>\nIf Extended ASCII is enabled and spanned SMS value is 1, a maximum of 140 characters can be sent.<br \/>\nIf Unicode is enabled and spanned SMS value is 1, a maximum of 70 characters can be sent.<br \/>\nIf the spanned SMS value is more than 1, the maximum number of characters allowed for each encoding scheme is defined as follows (where n represents the span value):<br \/>\nASCII \u2013 n * 154 characters<br \/>\nExtended ASCII \u2013 n * 134 characters<br \/>\nUnicode \u2013 n * 64 characters<br \/>\nAny characters entered beyond the allowed limit will be chopped off.<br \/>\nSending to a Group<br \/>\nThe API can be used to send SMS to a pre-defined group. The group should exist in the MultiModem iSMS. If the group does not exist, the message is dropped.<\/p>\n<p>HTTP API format is:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=1<br \/>\n[enc=1][priority=1][&amp;modem=4]&amp;group=\u201dadmin\u201d&amp;text=message<\/p>\n<p><\/code><br \/>\nor<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=1<br \/>\n[enc=2][priority=1][&amp;modem=4]&amp;group=\u201dadmin\u201d&amp;text=41;42;645;0645(hexadecimal form)<br \/>\n<\/code><br \/>\nor<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=1<br \/>\n[enc=3][priority=1][&amp;modem=4]&amp;group=\u201dadmin\u201d&amp;text=65;66;678(decimalform)<br \/>\n<\/code><br \/>\nThe parameters are:<br \/>\n\u2022 cat 1<br \/>\n\u2022 enc Encoding type to send SMS(Optional field)<br \/>\nRange: 0 to 3<br \/>\n0 &#8211; SMS text should be in ASCII form<br \/>\n1 &#8211; SMS text should be in Extended ASCII form<br \/>\n2 &#8211; SMS text should be in hexadecimal form (i.e. each hexadecimal value length<br \/>\nshould be maximum 4, and each hexadecimal value should be separated by<br \/>\na semi-colon. Example: 0645;41;646)<br \/>\n3 &#8211; SMS text should be in decimal form (i.e. each decimal Value length should<br \/>\nbe maximum 5, and each decimal value should be separated by a semi-colon<br \/>\nExample: 1605;65;65300)<br \/>\nNote: Maximum decimal value allowed is 65535.<br \/>\nIf enc is not specified in the send API request, default enc will be the configured settings from the SMS settings page.<br \/>\ni.e. enc=2, if Unicode is enabled.<br \/>\nenc=1, if Extended ASCII is enabled.<br \/>\nenc=0, if both Extended ASCII and Unicode are disabled.<br \/>\n\u2022 priority Priority to send SMS(Optional field)<br \/>\nRange: 1 to 3<br \/>\n1 &#8211; Low Priority<br \/>\n2 &#8211; Normal Priority<br \/>\n3 &#8211; High Priority<\/p>\n<p>If priority is not specified in the request, the default priority is normal.<\/p>\n<p>\u2022 modem Modem index to send SMS (this is only for the SF 400\/800 models)<br \/>\nRange : 1 to 4 for SF 400<br \/>\n1 to 8 for SF 800<br \/>\n0 for any modem (Send API job will be distributed via all the available<br \/>\nmodems)<br \/>\nIf modem is not specified in the request, send API job will be distributed via all the<br \/>\navailable modems.<br \/>\n\u2022 group The pre-defined group name(s) must be given within double quotes.<br \/>\nThe maximum size of group name is 50 bytes.<br \/>\n\u2022 text The message text to be sent.<br \/>\nEnable Extended ASCII in the MultiModem iSMS to send both ASCII and extended ASCII characters. By default, Extended ASCII is disabled, and the message can have only ASCII characters.<br \/>\nIf Unicode is enabled (and if enc is not specified in request), SMS text should only be in Hexadecimal form.<br \/>\nIf Extended ASCII and Unicode are disabled and spanned SMS value is 1, a maximum of 160 characters can be sent.<br \/>\nIf Extended ASCII is enabled and spanned SMS value is 1, a maximum of 140 characters can be sent.<br \/>\nIf Unicode is enabled and spanned SMS value is 1, a maximum of 70 characters can be sent.<br \/>\nIf the spanned SMS value is more than 1, the maximum number of characters allowed for each encoding scheme is defined as follows (where n represents the span value):<br \/>\nASCII \u2013 n * 154 characters<br \/>\nExtended ASCII \u2013 n * 134 characters<br \/>\nUnicode \u2013 n * 64 characters<br \/>\nAny characters entered beyond the allowed limit will be chopped off.<\/p>\n<p>Sending a Broadcast Trigger Message<\/p>\n<p>We can use the API to send a broadcast trigger message to the MultiModem iSMS.<\/p>\n<p>HTTP API format is:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user2&amp;passwd=user2&amp;cat=2<br \/>\n[&amp;enc=0][&amp;modem=5]&amp;text=message<br \/>\n<\/code><br \/>\nor<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user2&amp;passwd=user2&amp;cat=2<br \/>\n[&amp;enc=2][&amp;modem=5]&amp;text=message should be hexadecimal form<br \/>\n<\/code><br \/>\nor<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user2&amp;passwd=user2&amp;cat=2<br \/>\n[&amp;enc=3][&amp;modem=5]&amp;text=message should be decimal form<br \/>\n<\/code><br \/>\nThe parameters are:<br \/>\n\u2022 cat 2<br \/>\n\u2022 enc Encoding type to send SMS(Optional field)<br \/>\nRange: 0 to 3<br \/>\n0 &#8211; SMS text should be in ASCII form<br \/>\n1 &#8211; SMS text should be in Extended ASCII form<br \/>\n2 &#8211; SMS text should be in hexadecimal form (i.e. each hexadecimal value<br \/>\nlength should be maximum 4, and each hexadecimal value should be<br \/>\nseparated by a semi-colon. Example: 0645;41;646)<br \/>\n3 &#8211; SMS text should be in decimal form (i.e. each decimal Value length<br \/>\nshould be maximum 5, and each decimal value should be separated by a<br \/>\nsemi-colon. Example: 1605;65;65300)<br \/>\nNote: Maximum decimal value allowed is 65535.<br \/>\nIf enc is not specified in the send API request, default enc will be configured to the settings of the SMS settings page.<br \/>\ni.e. enc=2, if Unicode is enabled.<br \/>\nenc=1, if Extended ASCII is enabled.<br \/>\nenc=0, if both Extended ASCII and Unicode are disabled.<br \/>\n\u2022 modem Modem index to send broadcast message<br \/>\nRange : 1 to 4 for SF400<br \/>\n1 to 8 for SF800<br \/>\n0 for any modem (Broadcast API job will be distributed via all the available modems)<br \/>\nIf modem is not specified in the request, broadcast API job will be distributed via all the available modems<br \/>\nIf modem is specified, broadcast job will be sent via the specified modem.<\/p>\n<p>\u2022 text The trigger message text to be sent.<br \/>\nEnable Extended ASCII in the MultiModem iSMS to send both ASCII and extended ASCII characters.<br \/>\nBy default, Extended ASCII is disabled, and the message can have only ASCII characters.<br \/>\nIf Unicode is enabled (and if enc is not specified in request), SMS text should be only in Hexadecimal form.<br \/>\nIf Extended ASCII is disabled, a maximum of 160 characters can be sent.<br \/>\nIf Extended ASCII is enabled, a maximum of 140 characters can be sent.<br \/>\nIf Unicode is enabled, a maximum of 70 characters can be sent.<br \/>\nIrrespective of the spanned SMS value set, the maximum number of characters allowed in the text field is:<br \/>\n160 for ASCII<br \/>\n140 for Extended ASCII<br \/>\n70 for Unicode<br \/>\nAny characters entered beyond the allowed limit will be chopped off.<br \/>\nThe API can be used to send a trigger message to the MultiModem iSMS. If the MultiModem iSMS has a configured broadcast trigger, it will send the broadcast trigger message to the configured recipients.<\/p>\n<p>Sending an Action Trigger Message<\/p>\n<p>We could use this API to perform a predefined action.<\/p>\n<p>HTTP API format is:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=3<br \/>\n[&amp;enc=0]&amp;text=message<br \/>\n<\/code><br \/>\nor<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;cat=3<br \/>\n[&amp;enc=2]&amp;text=message should be hexadecimal form<br \/>\n<\/code><br \/>\nExample: Configured action trigger for adding preconfigured SMS as 41;42;43 (with enc=2).<br \/>\nPreconfigured SMS to add is 645;646;647;648 (in hexadecimal form).<br \/>\nIn an API request, the text field should be in the format:<br \/>\nConfigured action trigger;Preconfigured SMS<br \/>\ntext=41;42;43;;645;646;647;648 (not correct)<br \/>\ntext=41;42;43;3a;645;646;647;648 (correct format)<br \/>\nHere 3a is equivalent hexadecimal value for a semi-colon. We should use equivalent<br \/>\nhexadecimal value for either semi-colon or colon.<\/p>\n<p>or<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=3]&amp;text=message should be decimal form.<br \/>\n<\/code><br \/>\nExample: Configured action trigger for adding preconfigured SMS as 41;42;43(with enc=3).<br \/>\nPreconfigured SMS to add is 645;646;647;648 (in decimal form).<br \/>\nIn an API request, the text field should be in the format:<br \/>\nConfigured action trigger;Preconfigured SMS<br \/>\ntext=41;42;43;;645;646;647;648 (not correct)<br \/>\ntext=41;42;43;58;645;646;647;648 (correct format)<br \/>\nHere 58 is decimal equivalent value for a semi-colon. We should use equivalent decimal value for either semi-colon or colon.<br \/>\nIrrespective of the spanned SMS value set, the maximum number of characters allowed in the text field is:<br \/>\n160 for ASCII<br \/>\n140 for Extended ASCII<br \/>\n70 for Unicode<\/p>\n<p>Any characters entered beyond the allowed limit will be chopped off.<\/p>\n<p>Examples for action trigger with enc=2:<br \/>\nTo Add an entry in the Address book:<br \/>\nConfigured trigger: 41;42;43 (with enc=2)<br \/>\nName: 61;62;63;64 (abcd)<br \/>\nPhone number: 39;38;38;36;30;39;38;38;36;30 (9886098860)<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=41;42;43;3a;61;62;63;64;3a;39;38;38;36;30;39;38;38;36;30<br \/>\n<\/code><br \/>\nHere 3a is the equivalent hexadecimal for semi-colon. Instead of 3a, we can use 3b (equivalent hexadecimal value for colon) also.<\/p>\n<p>To Add a group name:<\/p>\n<p>Configured trigger: 44;45;46 (with enc=2)<br \/>\nGroup name: 65;66;67;68 (efgh)<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=44;45;46;3b;65;66;67;68<br \/>\n<\/code><br \/>\nTo Add a group name with a member and phone number:<br \/>\nConfigured trigger: 44;45;46 (with enc=2)<br \/>\nGroup name: 65;66;67;68 (efgh)<br \/>\nName: 61;62;63;64 (abcd)<br \/>\nPhone number: 39;38;38;36;30;39;38;38;36;30 (9886098860)<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=44;45;46;3b;65;66;67;68;3b;61;62;63;64;3b;39;38;38;36;30;39;38;38;36;30<br \/>\n<\/code><br \/>\nTo Add a group name with a member (should exist in Address book):<br \/>\nConfigured trigger: 44;45;46(with enc=2)<br \/>\nGroup name: 65;66;67;68 (efgh)<br \/>\nName: 61;62;63;64 (abcd)<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=44;45;46;3b;65;66;67;68;3b;61;62;63;64<\/code><\/p>\n<p>To delete an entry in the Address Book:<br \/>\nConfigured trigger: 47;48;49(with enc=2)<br \/>\nName: 61;62;63;64 (abcd)<br \/>\nPhone number: 39;38;38;36;30;39;38;38;36;30 (9886098860)<br \/>\nWith Name and Number:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=47;48;49;3a;61;62;63;64;3a;39;38;38;36;30;39;38;38;36;30<br \/>\n<\/code><br \/>\nWith Name only:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=47;48;49;3a;61;62;63;64<\/code><\/p>\n<p>With Number only:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=47;48;49;3a;3a;39;38;38;36;30;39;38;38;36;30<\/code><\/p>\n<p>To Delete a Group:<\/p>\n<p>Configured trigger: 4a;4b;4c (with enc=2)<br \/>\nGroup name: 65;66;67;68 (efgh)<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=user1&amp;passwd=user1&amp;<br \/>\ncat=3[&amp;enc=2]&amp;text=4a;4b;4c;3a;65;66;67;68<br \/>\n<\/code><br \/>\nThe parameters are:<br \/>\n\u2022 cat 3<br \/>\n\u2022 enc Encoding type to send SMS(Optional field)<br \/>\nRange: 0 to 3<br \/>\n0 &#8211; SMS text should be in ASCII form<br \/>\n1 &#8211; SMS text should be in Extended ASCII form<br \/>\n2 &#8211; SMS text should be in hexadecimal form (i.e. each hexadecimal value length<br \/>\nshould be maximum 4, and each hexadecimal value should be separated by a<br \/>\nsemi-colon. Example: 0645;41;646)<br \/>\n3 &#8211; SMS text should be in decimal form (i.e. each decimal Value length should be<br \/>\nmaximum 5, and each decimal value should be separated by a semi-colon.<br \/>\nExample: 1605;65;65300). Note: Maximum decimal value allowed is 65535.<br \/>\nIf enc is not specified in the send API request, default enc will be the configured settings in SMS settings page .<br \/>\ni.e. enc=2, if Unicode is enabled.<br \/>\nenc=1, if Extended ASCII is enabled.<br \/>\nenc=0, if both Extended ASCII and Unicode are disabled.<\/p>\n<p>\u2022 Modem Modem index to send SMS<br \/>\nRange : 1 to 4 for SF400<br \/>\n1 to 8 for SF800<br \/>\n0 for any modem<br \/>\nSpecifying modem for a cat=3 job is not applicable. Action trigger is executed even if modem is specified.<br \/>\n\u2022 text The trigger message text to be sent.<br \/>\nEnable Extended ASCII in the MultiModem iSMS to send both ASCII and extended ASCII chars.<br \/>\nBy default, Extended ASCII is disabled, and the message can have only ASCII characters.<br \/>\nIf Unicode is enabled(if enc is not specified in request), SMS text should be only in Hexadecimal form.<br \/>\nIf Extended ASCII is disabled, a maximum of 160 characters can be sent.<br \/>\nIf Extended ASCII is enabled, a maximum of 140 characters can be sent.<br \/>\nIf Unicode is enabled, a maximum of 70 characters can be sent.<br \/>\nThe API can be used to send an action trigger to the MultiModem iSMS. If the MultiModem iSMS has a configured action trigger, it will perform the configured action.<br \/>\nSending to Multiple Numbers, Address Book Recipients or Groups<br \/>\nAn SMS can be sent to multiple numbers, address book names and groups using a single API.<\/p>\n<p>HTTP API format is:<\/p>\n<p><code>http:\/\/192.168.2.1[:portnumber]\/sendmsg?user=xxx&amp;passwd=xxx&amp;cat=1[&amp;enc=0][&amp;priority=1][&amp;modem=8]&amp;to=\u201dxxx1\u201d,\u201dxxx2\u201d,\u201dxxx3\u201d&amp;ton=\u201dname1\u201d,\u201dname<br \/>\n2\u201d&amp;group=\u201dadmin\u201d,\u201drd\u201d,\u201dmarket\u201d&amp;text=message<br \/>\n<\/code><\/p>\n<p>xxx1, xxx2 and xxx3 are mobile numbers.<br \/>\nname1 and name2 are names in the Address Book.<br \/>\nadmin, rd and market are groups present in the MultiModem iSMS.<br \/>\nNote: The to, ton and group parameters should be enclosed in quotes.<br \/>\nResponse from the MultiModem iSMS after Submitting the Send SMS API<br \/>\nThe MultiModem iSMS returns a unique identifier; i.e. an API message ID for each &#8220;Send API request&#8221;.<br \/>\nThis ID can be used to track and monitor any given message.<br \/>\nID: apimsgid<br \/>\n-or-<br \/>\nErr: error code<br \/>\ne.g.,<br \/>\nID: 1<br \/>\nErr: 601<\/p>\n","protected":false},"excerpt":{"rendered":"<p>HTTP Send API Format Each &#8220;HTTP Send API Request&#8221; consists of four parts: \u2022 The first part is the destination; i.e., the MultiModem iSMS IP and HTTP port number. \u2022 The second part is the API call which is the query; therefore, it has a &#8216;?&#8217; post-fixed to the call. \u2022 The third part is [&hellip;]<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":88,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-290","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/290","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=290"}],"version-history":[{"count":10,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/290\/revisions"}],"predecessor-version":[{"id":587,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/290\/revisions\/587"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/88"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=290"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}