Appendix A – Application Programming Interface (API)
Multi-Tech Systems, Inc. SMSFinder User Guide for System Administrators (Document S000451B) 65
3.1.10 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&apim
sgid=id
Response values:
ID: apimsgid Status: status code
OR
ID: apimsgid Err: error code
OR
Err: error code
e.g.,
ID: 1 Status: Done
ID: 1 Err: 604
Err: 602
3.1.11 Status Codes
Status Code Status Description Description
0 Done The SMSFinder has completed servicing the "Send"
job, and a message is sent to all the recipients.
1 Done with error The SMSFinder has completed servicing the "Send"
job, but the message is not sent to all the recipients
2 In progress The SMSFinder is processing the "Send" API.
3 Request Received The SMSFinder has received the "Send" request.
4 Error Error occurred while sending the SMS from the
SMSFinder.
5 Message ID Not Found An API Message ID does not exist.
3.1.12 Error Codes
Error Code Error Description Response to
601 Authentication Failed Send API, Query API
602 Parse Error Send API, Query API
603 Invalid Category Send API
604 SMS message size is greater than 160 chars Send API
605 Recipient Overflow Send API
606 Invalid Recipient Query API
607 No Recipient Send API
608 SMSFinder is busy, can’t accept this request Send API, Query API
609 Timeout waiting for a TCP API request Send API
610 Unknown Action Trigger Send API
611 Error in broadcast Trigger Send API
612 System Error. Memory Allocation Failure Send API, Query API
Note: The maximum supported size of the URL is 2048 bytes.
To Next Page
Loading...
