Esendex provides a SOAP web service interface to enable developers to integrate SMS functionality into their applications. All services are accessible using the HTTP or HTTPS protocols.
There are two versions of the SOAP XML SMS API. This page describes the primary interface which makes use of SOAP Headers to carry authentication information (account, username and password).
There are several environments, e.g. Coldfusion, that do not have support for SOAP Headers. The SOAP XML SMS API - No Headers service incorporates the authentication information in the arguments to each method call.
Full sample implementations are included in the SMS SDKs and we encourage anyone investigating the use of the SOAP API methods to start there. If you required any assistance please contact Support.
The SOAP XML SMS API provides functionality through the following services:
Sending
| Service |
Description |
|
| SendService |
Methods to send SMS messages individually and in batches |
URI,WSDL |
| SendContentService |
Methods to send SMS messages for delivering content, eg WAP Push, individually and in batches |
URI,WSDL |
| ScheduledSendService |
Submits a message to Esendex that is scheduled to be sent at a later date/time |
URI,WSDL |
Notes
The service aliasing feature within the SendMessageFull and SendMessageMultipleRecipientsFull methods of SendService 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 |
|
| InboxService |
Manage incoming messages queued in the account inbox |
URI,WSDL |
| AccountEventHandler |
Enables our system to notify your system when account events occur, for example receiving a message. This is an interface definition for a web service you create on your public web server.
For more information, see Account Event Handler. |
URI,WSDL |
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.
Other
| Service |
Description |
|
| AccountService |
Account management functionality |
URI,WSDL |
| ContactService |
Contact and Contact Group management functionality |
URI,WSDL |
| SubscriptionService |
Subscription management functionality |
URI,WSDL |
Errors
If an error occurs when you are submitting a request to a web service you will receive a SOAP error that describes what the problem was. This information is in the Detail section of the XML, and consists of two nodes ErrorCode and ErrorMessage. There is a full list of Error Codes to help you diagnose any problems.