Esendex provides a Form Post interface to enable developers to integrate SMS functionality into their applications. All services are accessible using either HTTP or HTTPS protocols.
The Form Post API provides functionality through the following services:
Sending
| Service |
Description |
|
| SendSMS |
SMS message sending functionality |
URI |
| SendWapPushSMS |
Send a WAP Push SMS to a handset |
URI |
| ScheduledSendSMS |
Submits a message to Esendex that is scheduled to be sent at a later date/time |
URI |
| QueryStatus |
Find out the status of sent messages |
URI |
Notes
The service aliasing feature within the SendSMS service is not available with Evaluation or Premium accounts. When using these methods, you must set the Originator parameter to your account reference or you will receive an error when attempting to send a message.
Receiving
| Service |
Description |
|
| GetInboxMessage |
Retrieve inbox messages |
URI |
| DeleteInboxMessage |
Delete inbox messages |
URI |
| AccountEventHandler |
Enables our system to notify your system when account events occur, for example receiving a message. This describes the form post parameters your service will receive when events occur. |
URI |
| GetLatestInboxMessages |
Retrieves the messages that were received after a specified message |
URI |
Notes
Once the AccountEventHandler as been created on your public server, you configure your account to call your web service in the Account Notification section of the Messenger Options page.
We recommend that upon receipt of a message via the AccountEventHandler service it is deleted from the inbox using the InboxService. This allows your system to complete the message delivery transaction while maintaining a queue of messages, should your server be unavailable when a message arrives.
Contact Management
| Service |
Description |
|
| AddContact |
Adds contacts |
URI |
| AddContactGroup |
Adds a contact group with an initial set of members |
URI |
| DeleteContact |
Deletes contacts |
URI |
| DeleteContactGroup |
Deletes contact groups |
URI |
| GetContact |
Retrieves contact information |
URI |
| GetContactGroup |
Retrieves contact group information |
URI |
| GetContactGroupMembers |
Gets the contacts that are members of a group |
URI |
| UpdateContact |
Updates contact information |
URI |
| UpdateContactGroup |
Updates contact group information including its members |
URI |
Subscription Management
| Service |
Description |
|
| StopSubscription |
Stops a subscription for a mobile number to a premum service |
URI |