Difference between revisions of "MO SOAP"

Revision as of 09:10, 6 May 2011

Collecting mobile originated messages from your account using SOAP methods is done using 4 available functions:

• GetNewInboxCount - returns the number of new messages in your Inbox

• GetNewInboxMessages - Gets new sms messages from your inbox (maximum 300). Upon collection, messages are set to "read"

• GetTopMessage - Used to get the latest new sms message in inbox. Message flag is set to "read" after this function is completed

• GetBottomMessage - Used to get the earliest new sms message in inbox. Message flag is set to "read" after this function is completed

Before you can use these functions you must obtain Token/Signature for your account. This is needed only once.

Results

Result of method GetNewInboxCount

<?xml version="1.0" encoding="utf-8" ?> <int xmlns="http://upsidewireless.com/webservice/sms">2</int>

If no new messages exist the function returns 0.

Result of method GetNewInboxMessages

 <?xml version="1.0" encoding="utf-8" ?> 

- <ArrayOfNewSMSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms"> - <NewSMSMessage>

 <isValid>true</isValid> 
 <sender>+17788580767</sender> 
 e test email command 
 <name>username</name> 
 <inboundnumber>16047658410</inboundnumber> 
 <messageid>Mail1280535182021-4</messageid> 
 </NewSMSMessage>

- <NewSMSMessage>

 <isValid>true</isValid> 
 <sender>+17788580767</sender> 
 test message 
 <name>username</name> 
 <inboundnumber>16047658410</inboundnumber> 
 <carriercode>302720</carriercode> 
 <messageid>Mail1300928784355-5</messageid> 
 </NewSMSMessage>
 </ArrayOfNewSMSMessage>

If no new messages exist, there will be no NewSMSMessage blocks. All new messages will be set to "read" so you will no longer be able to fetch them.

Result of method GetTopMessage

 <?xml version="1.0" encoding="utf-8" ?> 

- <NewSMSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">

 <isValid>true</isValid> 
 <sender>+17788580767</sender> 
 test message 
 <name>taylorsun</name> 
 <inboundnumber>16047658410</inboundnumber> 
 <carriercode>302720</carriercode> 
 <messageid>Mail1300928784355-5</messageid> 
 </NewSMSMessage>

If no new messages exist, there will be no sender, data.. blocks. If there are new messages you will get the top message. Upon retrieval, its flag will be set to "read" so you will no longer be able to fetch it.

Result of method GetBottomMessage

 <?xml version="1.0" encoding="utf-8" ?> 

- <NewSMSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://upsidewireless.com/webservice/sms">

 <isValid>true</isValid> 
 <sender>+17788580767</sender> 
 e test email command 
 <name>taylorsun</name> 
 <inboundnumber>16047658410</inboundnumber> 
 <messageid>Mail1280535182021-4</messageid> 
 </NewSMSMessage>

If no new messages exist, there will be no sender, data.. blocks. If there are new messages you will get the bottom (earliest received) message. Upon retrieval, its flag will be set to "read" so you will no longer be able to fetch it.