|
|
Bulk SMS API Integration Guide.
| HTTP Post/Get |
When posting the
variable/values can either be placed in the URL or posted. The
response needs to be retrieved from the post/get and
interpreted.
Check Credits:
http://www.yebosms.co.za/httppost4.aspx?type=credits&username=YOUR_USERNAME&password=YOUR_PASSWORD
Single SMS:
http://www.yebosms.co.za/httppost4.aspx?type=singlesms&username=YOUR_USERNAME&password=YOUR_PASSWORD
&Number=xxxx&Message=Testing
Optional
Senddate
: 13/apr/2007 (format dd/MMM/yyyy).
Sendtime
: 15:34 (format HH:mm)
CustomerID : 50 char string unique to your system for reporting
purposes
Bulk SMS:
http://www.yebosms.co.za/httppost4.aspx?type=bulksms&username=YOUR_USERNAME&password=YOUR_PASSWORD
&Data=see_below
Data format:
<event><sms><num>083123456</num><msg>Testing the xml string</msg><id>1</id></sms>
<sms><num>083123457</num><msg>Testing
the xml string</msg><id>2</id></sms></event>
Replace any data within the XML tags: < with %26lt;
Replace any data within the XML tags: > with %26gt;
Replace any data within the XML tags: & with %26amp;
Optional
Senddate
: 13/apr/2007 (format dd/MMM/yyyy).
Sendtime
: 15:34 (format HH:mm)
Replies:
http://www.yebosms.co.za/httppost4.aspx?type=replies&username=YOUR_USERNAME&password=YOUR_PASSWORD&ID=0
The first call must be a '0'. An XML result set is returned
containing a unique ID for every incoming sms, this needs to be
stored along with the results. For each subsequent call the max
IncomingID must be used to retrieve any new incoming messages.
We can also push incoming replies to a URL of your choice. This
means that you don't have to poll our gateway, which cuts down
on unnecessary calls. Please email us if you would like this
facility.
The following parameters are pushed:
IncomingID : Unique per incoming message
Phonenumber : Mobile number
IncomingData : The data that was received
IncomingDataTime : Date and time the message was received
SentID :
Unique ID for the sent message
EventID
: Tracking ID. This number was returned when posting your
messages.
SentData
: The sent message
SentDataTime : Date and time of the sent message
CustomerID : The customerid passed in when sending
SentMessageGRPName : The group name the number belonged to,if
sending from the website
SentMessageGRPDesc : The group description the number belonged
to,if sending from the website
NumberValue1 : The Value1 field associated with the number,if
sending from the website
NumberValue2 : The Value2 field associated with the number,if
sending from the website
NumberValue3 : The Value3 field associated with the number,if
sending from the website
NumberValue4 : The Value4 field associated with the number,if
sending from the website
NumberValue5 : The Value5 field associated with the number,if
sending from the website
NumberValue6 : The Value6 field associated with the number,if
sending from the website
EG: yoururl.aspx?IncomingID=1234&Phonenumber=xxxxx&IncomingData=Test.......
Sent:
http://www.yebosms.co.za/httppost4.aspx?type=sent&username=YOUR_USERNAME&password=YOUR_PASSWORD&ID=0
The first call must be a '0'. An XML result set is returned
containing a unique ID for every sent sms, this needs to be
stored along with the results. For each subsequent call the max
ID must be used to retrieve any new sent messages.
We can also push sent items to a URL of your choice. This means
that you don't have to poll our gateway, which cuts down on
unnecessary calls. Please email us if you would like this
facility.
The following parameters are pushed:
ID : Unique per sent message
EventID
: Tracking ID. This number was returned when posting your
messages.
Phonenumber : Mobile number
SentData
: Message submitted
SentDataTime: Date and time the message was sent
Status: Delivery status
CustomerID : The customerid passed in when sending |
|
| Web Services |
Add a web
reference to http://www.yebosms.co.za/sendsms4.asmx. A number of
methods are exposed. The methods accept the same parameters (formnat)
as above.
Methods for sending include a parameter 'SenderID'. Please note
that this is only exposed for certain countries. This field can
be left blank.
Sending from a dataset can be performed by calling the method 'BulkSMSDataset'
This method accepts a dataset as a parameter. The dataset needs
to contain ONE table with 3 columns named 'Num', 'Msg' and 'ID'.
Num - The number you wish to send to.
Msg -
The message you wish to send to the corrosponding number.
ID - A unique ID value that you can attach to each message
Replies:
Replies can be retrieved in the form of an XML string - 'RepliesXML'
or a dataset - 'RepliesDataset'.
The first call must be a '0'. An XML string or Dataset is
returned containing a unique ID for every incoming sms, this
needs to be stored along with the results. For each subsequent
call the max IncomingID must be used to retrieve any new
incoming messages.
We can also push incoming replies to a URL of your choice. This
means that you don't have to poll our gateway, which cuts down
on unnecessary calls. Click here to setup this feature
The following parameters are pushed:
IncomingID : Unique per incoming message
Phonenumber : Mobile number
IncomingData : The data that was received
IncomingDataTime : Date and time the message was received
SentID :
Unique ID for the sent message
EventID
: Tracking ID. This number was returned when posting your
messages.
SentData
: The sent message
SentDataTime : Date and time of the sent message
CustomerID : The customerid passed in when sending
SentMessageGRPName : The group name the number belonged to,if
sending from the website
SentMessageGRPDesc : The group description the number belonged
to,if sending from the website
NumberValue1 : The Value1 field associated with the number,if
sending from the website
NumberValue2 : The Value2 field associated with the number,if
sending from the website
NumberValue3 : The Value3 field associated with the number,if
sending from the website
NumberValue4 : The Value4 field associated with the number,if
sending from the website
NumberValue5 : The Value5 field associated with the number,if
sending from the website
NumberValue6 : The Value6 field associated with the number,if
sending from the website
EG: yoururl.aspx?IncomingID=1234&Phonenumber=xxxxx&IncomingData=Test.......
Sent:
Sent items can be retrieved in the form of an XML string - 'SentXML'
or a dataset - 'SentDataset'.
The first call must be a '0'. An XML or dataset is returned
containing a unique ID for every sent sms, this needs to be
stored along with the results. For each subsequent call the max
ID must be used to retrieve any new sent messages.
We can also push sent items to a URL of your choice. This means
that you don't have to poll our gateway, which cuts down on
unnecessary calls. Click here to setup this feature
The following parameters are pushed:
ID : Unique per sent message
EventID
: Tracking ID. This number was returned when posting your
messages.
Phonenumber : Mobile number
SentData
: Message submitted
SentDataTime: Date and time the message was sent
Status: Delivery status
CustomerID : The customerid passed in when sending |
|
| FTP |
FTP Details:
IP: 206.225.83.190
FTP username: ftpsms
FTP password: ftpsms
The account has only write and list privilages. The folder is
monitored every 5 seconds for incoming files.
To send via FTP you need to create a file in the following
format (comments in brackets):
5 (File type, first line)
YOUR_USERNAME (your username)
YOUR_PASSWORD (your password)
email@email.co.za (A FTP status email is sent here. Multiple
emails seperated with a comma)
23/Oct/2008 (date format dd/MMM/yyyy)
07:39 (time format HH:mm)
(blank line)
Number1~Message1~CustomerID1
Number2~Message2~CustomerID2
Number3~Message3~CustomerID3
Number4~Message4~CustomerID4 |
|
|
