Difference between revisions of "MO SOAP"

Revision as of 16:34, 5 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

Send_Plain_Multiple is API function that allows you to send up to 25 messages (same message to 25 recipients) with one function call. This page describes error statuses which Send_Plain_Multiple can generate

Send successful - all messages were sent

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

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

 <isOk>true</isOk> 
 <successCount>3</successCount> 
 <failedCount>0</failedCount> 
 </SMSSendMultipleResult>

Failed sending or partial fail

No recipients - no message will be sent

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

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

 <isOk>false</isOk> 
 <successCount>0</successCount> 
 <failedCount>0</failedCount> 
 <errorMessages>No recipients</errorMessages> 
 </SMSSendMultipleResult>

Excess maximum recipients - no message will be sent

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

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

 <isOk>false</isOk> 
 <successCount>0</successCount> 
 <failedCount>26</failedCount> 
 <errorMessages>Excess maximum recipients (25)</errorMessages> 
 <errorNumbers>17788580767,16046668888,17788456789, 456789, 123456, 65743211, ...</errorNumbers> 
 </SMSSendMultipleResult>

Partial Success - some messages will not be sent (in the below example 2)

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

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

 <isOk>false</isOk> 
 <successCount>3</successCount> 
 <failedCount>2</failedCount> 
 <errorMessages>recipient length invalid,recipient length invalid</errorMessages> 
 <errorNumbers>456789,123456</errorNumbers> 
 </SMSSendMultipleResult>