|
Support @ smsCentral
XML: SMSSend Fuction
Below are the specifications for the SMSSend
method of the smsCentral XML. Including linking requirements
and field explanations.
The following table outlines the XML sent and
received from the smsCentral XML page:
|
The following is an
example of the XML sent to the smsCentral XML Page; |
<SendSMS>
<From>smsCentral</From>
<To>0416292163</To>
<Message>Hello</Message>
<Username>test@smscentral.com.au</Username>
<Password>2P@ssword!</Password>
</SendSMS> |
|
The following is an
example of the XML returned after a successful
transaction; |
<smsResponse>
<smsFrom>smsCentral</smsFrom>
<smsNumbers>
<string>0416292163</string>
<string>0416239165</string>
</smsNumbers>
<smsMessage>Hello</smsMessage>
<smsNumbersCount>1</smsNumbersCount> <smsPerTransactionCost>1</smsPerTransactionCost>
<smsTotalCost>1</smsTotalCost>
<status>True</status>
<statusID>1</statusID>
<errormessage></errormessage>
<transactionID>38674298</transactionID>
</smsResponse> |
The following tables
outline the maximum string lengths that can be passed to the
smsCentral XML page. If data is passed of a greater length then
it is ignored.
|
Field Name |
Maximum Field Length (characters) |
Required Field |
|
From * |
50 |
 |
|
To |
1024 |
|
|
Message |
165 |
|
|
Username |
50 |
|
|
Password |
50 |
|
The following table gives a description of all
the fields involved in the Send function.
|
Field Name |
Description |
|
From * |
This field is now defunct, and no longer
generates the SMS from field. Is has remained to ensure clients
using the legacy system are not affected. |
|
To |
A list of the mobile numbers to send the
SMS to. To send to multiple mobiles seperate the mobile numbers
by a ','. eg. 0421858585, 0416292163 |
|
Message |
The message to send to the selected
mobiles. |
|
smsID |
The unique identifier
of the message that you sent. Each message is assigned its own
identifier. |
|
smsFrom * |
This field is now defunct, and no longer
generates the SMS from field. Is has remained to ensure clients
using the legacy system are not affected. |
|
smsNumbers |
A list of the mobile numbers the SMS was
sent to. |
|
smsMessage |
The SMS that was sent to the selected
mobiles. |
|
smsNumbersCount |
The number of mobiles the message was sent
to. |
|
smsPerTransactionCost |
The cost in credits of each individual message. |
|
smsTotalCost |
The total cost of the transaction.
smsTotalCost = smsNumbersCount * smsPerTransactionCost. |
|
status |
The result of the SMS, ie True or False. |
|
statusID |
An ID indicating the status of the SMS,
0=pending, 1=delivered, 2=failed, 3=error |
|
errormessage |
Possible error message ie no such number. |
|
transactionID |
A unique idnetifier for each SMS, enabling
you to look up the status of an SMS. |
Return to smsCentral support
|
