This document provides the technical details of the XML based SMS API for the FEBNO SMS Engine Suite. This API is provided for customers to use any standard software development application to send Multi SMS Messages through the Gateway. This protocol is best suited for offline application who wishes to send messages by calling the function each time.
How to Use the API
Any standard software development tool can be used to use the XML API. The following are the steps required to send a message.
Create an XML message using the format specified
Send the XML to the http URL provided as a Form Data
Receive the XML response and check the status of the request
Recommended to input 100 records in single XML.
User Validation
User validation is done using the user id and password specified in the XML element
Programming Details
XML Tag for Sending
<SMS> <UserID>XXXX@febnosms.com</UserID> <Pwd>XXXXXXXX@@@@@</Pwd> <Messages>
<Message> <MobileNumber>XXXXXXXXXMOBILE1, XXXXXXXXXMOBILE2, XXXXXXXXXMOBILE3</MobileNumber>
<SenderID>XXXXXXX</SenderID><Text>Msg1</Text><Unicode>0</Unicode>
</Message>
<Message><MobileNumber>XXXXXXXXXMOBILE4</MobileNumber><Text>Msg2</Text><Unicode>1</Unicode>
</Message> </Messages> </SMS>
The URL to post is http://www.febnosms.com/ClientAPIV3/SubmitMultiXML.aspx
XML Tag Response
<?xml version='1.0' encoding='utf-8' ?> <SMS> <Responses>
<MessageResponse><MobileNumber>XXXXXXXXXMOBILE1</MobileNumber><SMSREF>2007XXXXXXX</SMSREF><Status>OK</Status>
</MessageResponse>
<MessageResponse><MobileNumber>0507351903</MobileNumber><SMSREF> XXXXXXXXXMOBILE2</SMSREF><Status>OK</Status>
</MessageResponse></Responses><Status>Error</Status><Error></Error>
</SMS>
Sample .NET Code
Dim strXML As StringDim txtResponse As String
strXML = "<SMS>"strXML = strXML & "<UserID>XXXXXXXX</UserID>"strXML = strXML & "<Pwd>XXXXXX<Pwd>"strXML = strXML & "<CampaignID>adsmall11</CampaignID>"strXML = strXML & "<Messages>"strXML = strXML & "<Message><MobileNumber>055XXXXXXXX</MobileNumber>"strXML = strXML & "<Text>Msg1</Text>"strXML = strXML & "<Unicode>0</Unicode></Message>"strXML = strXML & "<Message><MobileNumber>055XXXXXXXX</MobileNumber>"strXML = strXML & "<Text>Msg2</Text>"strXML = strXML & "<Unicode>1</Unicode></Message>"strXML = strXML & "</Messages></SMS>"
txtResponse = ""Dim strURL As String
strURL = "http://www.febnosms.com/ClientAPIV3/SubmitMultiXML.aspx"
Dim objWebResponse As HttpWebResponse = NothingDim objStreamWriter As StreamWriter = NothingDim objStreamReader As StreamReader = NothingDim objWebRequest As HttpWebRequest = Nothing
objWebRequest = DirectCast(WebRequest.Create(strURL), HttpWebRequest)objWebRequest.Method = "POST"objWebRequest.ContentType = "text/plain"
objStreamWriter = New StreamWriter(objWebRequest.GetRequestStream())objStreamWriter.Write(strXML)objStreamWriter.Flush()objStreamWriter.Close()
objWebResponse = DirectCast(objWebRequest.GetResponse(), HttpWebResponse)objStreamReader = New StreamReader(objWebResponse.GetResponseStream())txtResponse = objStreamReader.ReadToEnd()
txtResponseTxt.Text = txtResponse