Receive SMS
...
The gateway is able to host a dedicated number on which to receive SMS. All SMS messages received on this number can be forwarded in one of the following ways. Initially this will need to be configured by Amethon. For each received message we know the following:
- sender: the number of the person who sent the message
- recipients: the number to which the message was sent (this is the hosted number)
- text: the SMS message text
an email is sent to a preconfigured email address. The email will appear to come from phoneNumber@amethon.net (eg 6142154353@amethon.net). It's subject will be "SMS Message Received" and the email body will contain the SMS text.
HTTP GET
A remote URL can be called passing as parameters the sender, recipient and SMS text details. Eg
http://www.company.com/receive.asp?sender=61450123123&recipient=61414414414&message=Hello+World
Web Service
A remote Web Service can be called passing as parameters the sender, recipient and SMS text details.
method | parameters | return |
|---|---|---|
receive | (String sender, String recipient, String text) | Boolean (success | failure) |
- 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.
method | parameters | return | |||||||
|---|---|---|---|---|---|---|---|---|---|
receive ( |
|
|
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. |