SMS XML-RPC Gateway
XML-RPC is an XML-based, remote procedure call protocol which is easy to implement in a variety of environments. If you're new to this protocol, we can provide consultancy on implementing it in a variety of environments including PHP, ASP, Cocoa/Objective4D, Visual Basic and 4th Dimension. Or you can get complete details of a variety of implementations and the complete specification at the XML-RPC Homepage.
As long as you're able to create a simple XML document and use HTTP POST to send it to a website, you're able to use our XML-RPC SMS Gateway.
RPC Methods Available
At the moment, our XML-RPC gateway lets you send SMS messages, check your SMS balance and get a complete breakdown of transactions between date/time ranges. Here is an example of the procedure calls available. Full documentation is available on request.
|
|
|
|
Procedure: sms.sendMessage() |
|
|
|
|
|
Input Parameters |
|
|
string : gatewayUsername |
Your SMS account username |
|
|
string : gatewayPassword |
Your SMS account password |
|
|
string/array : smsTo |
Either a comma separated string of numbers to send the message to, or an array of numbers to send the messages to. |
|
|
string : smsFrom |
The number or short name you are sending the message from. If left blank, the default 'SMS From' for you account will be used instead. |
|
|
string : smsMessage |
The text of the message, maximum 160 characters. |
|
|
|
|
|
Output (struct) |
|
|
int : resultCode |
The result of the procedure call, zero if OK, otherwise an error code. |
|
|
int : transactionID |
The transaction ID if it was successful. |
|
|
int : balance |
The number of message credits available in the account. |
|
|
|
|
|
|
|
|
|
|
|
Procedure: sms.getCreditBalance() |
|
|
|
|
|
Input Parameters |
|
|
string : gatewayUsername |
Your SMS account username |
|
|
string : gatewayPassword |
Your SMS account password |
|
|
|
|
|
Output |
|
|
int : balance |
Your current message credit balance. Negative balances indicate how many messages you have used over your prepaid credits for the period. |
|
|
|
|
|
|
|
Note to Standingwave Virtual Hosting Customers: If you have a Standingwave Virtual Server, you already have access to these scripts directly from your PHP Code without having to use XML-RPC at all. Contact our technical department by email for more details either using our enquiry form for someone to contact you directly.
Note to 4D Developers: We can provide an XML-RPC component and associated SMS code for developers using 4D version 6.7.x and upwards. The component uses Expat4D as the parser and ObjectTools internally to represent the variety of data structures supported in XML-RPC. Contact our technical department by email for more details either using our enquiry form for someone to contact you directly.
|
