Receive SMS - Message Polling
Client can poll for incoming messages via the following call. Criteria is provided an array of Option (see below for a list of valid criteria specifications). An array of Message is returned upon each call. In the case of error, an array contains a single Message with Subject field set to the corresponding error code is returned.
Only messages in response to SMS that have had a replyTo value set to "inbox:" will be retrieved.
This method is not HTTP Get compatable.
Method recieve
method |
parameters |
return |
|---|---|---|
receive |
Stringusername,Stringpassword, Option[] criteria |
Message[] |
Polling criteria include:
Criterion |
Description |
|---|---|
document-id |
A valid documentId returned by MessageCore previously. |
source |
A particular source address. |
destination |
A particular destination address. |
period-from |
(YYYY/MM/DD HH:MM:SS) The arrival time lower limit. this exact format must be used eg 2008/10/12 00:00:00 |
period-to |
(YYYY/MM/DD HH:MM:SS) The arrival time upper limit. this exact format must be used eg 2008/10/13 00:00:00 |
tag |
User defined tag. |
max-messages |
Max. number of messages return. Default is 1000. |
poll-status |
Either POLLED or UNPOLLED |
Method receiveUnpolled
Client can poll for incoming messages that have not been previously polled for by using the receiveUnpolled method. This method is the same as the receive method with the option value defaulted to unpolled. This method can be called using HTTP Get
Only messages in response to SMS that have had a replyTo value set to "inbox:" will be retrieved.
method |
parameters |
return |
|---|---|---|
receiveUnpolled |
String username, String password, |
Message |