Versions Compared

Version Old Version 4 New Version 5
Changes made by

Anh Nguyen

Anh Nguyen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Note

Only messages in response to SMS that have had a replyTo value set to "inbox:" will be retrieved.

method

parameters

return

receive

Code Block
String   username
String   password
Option[] criteria
Code Block
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.

period-to

(YYYY/MM/DD HH:MM:SS) The arrival time upper limit.

tag

User defined tag.

max-messages

Max. number of messages return. Default is 1000.