HTTP Query API Format
\nProcessing the “Send API” and sending the message takes some time. So, only an apimsgid is returned
\nas a response to the “Send SMS API”. Query API can be used to query the status of a Send. It returns
\nthe status of a message submitted earlier.
\nHTTP API format is:
\nhttp:\/\/192.168.2.1[:portnumber]\/querymsg?user=xxx&passwd=xxx&apimsgid
\n=id
\nResponse values:
\nID: apimsgid Status: status code
\nOR
\nID: apimsgid Err: error code
\nOR
\nErr: error code
\ne.g.,
\nID: 1 Status: Done
\nID: 1 Err: 604
\nErr: 602
\nNote: The maximum supported size of the URL is 2048 bytes.
\nStatus Codes
\nStatus Code Status Description Description
\n0
\nDone The MultiModem iSMS has completed servicing the
\n“Send” job, and a message is sent to all the recipients.
\n1
\nDone with error The MultiModem iSMS has completed servicing the
\n“Send” job, but the message is not sent to all the
\nrecipients
\n2 In progress The MultiModem iSMS is processing the “Send” API.
\n3
\nRequest Received The MultiModem iSMS has received the “Send”
\nrequest.
\n4
\nError Error occurred while sending the SMS from the
\nMultiModem iSMS.
\n5 Message ID Not Found An API Message ID does not exist.
\n6 Distributed to Slave1
\n[10.10.10.101]
\nThe Master MultiModem iSMS has distributed the Job
\nto a given slave.
\n7 Distribution resulted in
\nerror
\nMaster tried to send the job to the slaves and could
\nnot send the job to any of the slaves as the slaves are
\nnot available (loaded full or network unreachable)
\n8 Distributed among
\nmany Slaves
\nThe Master MultiModem iSMS has distributed the Job
\nRequest among many Slaves.
\n9 API is canceled Reflects that API job is dropped if the Send API job is
\ncanceled from the WEB GUI
\nAppendix A \u2013 Application Programming Interface (API)
\nMulti-Tech Systems, Inc. MultiModem\u00ae iSMS User Guide for Administrators 85
\nError Codes
\nError Code Error Description Response to
\n601 Authentication Failed Send API, Query API
\n602 Parse Error Send API, Query API
\n603 Invalid Category Send API
\n604 SMS message size is greater than 160 chars Send API
\n605 Recipient Overflow Send API
\n606 Invalid Recipient Query API
\n607 No Recipient Send API
\n608 MultiModem iSMS is busy, can\u2019t accept this request Send API, Query API
\n609 Timeout waiting for a TCP API request Send API
\n610 Unknown Action Trigger Send API
\n611 Error in broadcast trigger Send API
\n612 System Error \u2013 Memory Allocation Failure Send API, Query API
\n613
\nInvalid Modem Index
\nIn SF 400, if modem index given is not within 0 to 4
\nIn SF 800, if modem index given is not within 0 to 8
\nSend API
\n614
\nInvalid device model number
\n(model number is not detected properly to validate
\nthe modem index)
\nSend API
\n615 Invalid Encoding type Send API
\n616 Invalid Time\/Date Input Receive API
\n617 Invalid Count Input Receive API
\n618 Service Not Available (Non-Polling Receive API is
\nenabled so Polling Receive API service is not
\navailable)
\nReceive API
\n619 Invalid Addressee Receive API
\n620 Invalid Priority value Send API
\n621 Invalid SMS text
\nThis error code is given if the following is not true:
\nIf enc = 2, SMS text should be in hexadecimal form
\n(each hexadecimal value length is a maximum of 4
\ndigits and semi-colon is used as a delimiter between
\ntwo hexadecimal values).
\nIf enc = 3, SMS text should be in decimal form (each
\ndecimal value length is maximum 5 digits and semicolon
\nis used as delimiter between two decimal
\nvalues).
\nNote: Decimal values allowed up to 65535 only.
\nSend API<\/p>\n","protected":false},"excerpt":{"rendered":"
HTTP Query API Format Processing the “Send API” and sending the message takes some time. So, only an apimsgid is returned as a response to the “Send SMS API”. Query API can be used to query the status of a Send. It returns the status of a message submitted earlier. HTTP API format is: http:\/\/192.168.2.1[:portnumber]\/querymsg?user=xxx&passwd=xxx&apimsgid […]<\/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-304","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/304","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=304"}],"version-history":[{"count":3,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/304\/revisions"}],"predecessor-version":[{"id":585,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/304\/revisions\/585"}],"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=304"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}