|
|
1601SMS Gateway API is a flexible
online environment for effective
communication via SMS.
Send messages from your own
application to our SMS Gateway,
which automatically converts
messages and delivers them as SMS.
Log in to the online user interface of the
SMS Gateway and send SMS messages to
different audiences, or link your
own CRM package to our SMS Gateway.
|
|
|
|
Applications for
using our
Gateway API are;
❶
Planning
or
inventory
system
linked to
SMS.
Inform
your
customers
by
SMS
about
the
status
of orders
❷
Integrate SMS Service to make your website more
interactive: Think abount route via sms, contact information or the
latest news by SMS
❸ Streamlining
internal business processes,
fixing
appointments
for your
sales
team,
important
announcements,
receive
notifications
when
your
server
is down
etc.
..
|
|
|
|
|
Note:
You need to encode the POST url before you send the
request. Eg: message=This is a test , this has to be:
message=this%20is%20a%20test . In PHP there is a
function for this:
urlencode($url);
This url encoding must happen before sending the
request to our API! You also have to encode the
sender name.
|
|
|
|
|
Parameter |
Explanation |
Remark |
|
klantuser |
Your username |
The
username you received from us |
|
klantpwd |
Your password |
The
password you received from us (you can
encode this password with
SHA-1
for extra
security) |
|
bericht |
The text
message |
Note: The
message must be urlencoded before you send
the request. (this is a test = this%20is%20a%20test) |
|
naar |
The recipient |
A valid
mobile number (starting with the correct
country code: eg 32478123456)
You can also use multiple numbers by
separating them with a comma
(&to=32478123456,31600123456) |
|
afzender |
the sendername |
|
|
|
|
|
|
Optional parameters |
|
logging=ja {yes} |
Logging
function |
If you
add logging=ja, all sms sendings are
automatically stored in the history of the
SMS module. If you add logging=nee no SMS
loggings will be made. |
|
delivery=ja
{yes} |
Delivery
reports |
If you
add delivery=ja you get a reply with OK + a
smsID.
Eg : OK 1234567
You can catch this ID and perform a callback
to request the delivery report later. |
|
type=long |
sending
long messages |
When you
use type=long ,you can send messages larger
than 160 characters. The messages are sent seperated and become 1 message on the
receivers phone. You can use a max. of 459
characters (seperated to a maximum of 3 messages).
Note: you can only use 153 characters per
text message when using long SMS (the other
7 characters are used by the system).
|
|
datum=yyyymmddhhii |
schedule
SMS on specific date and time |
If you
use parameter datum=yyyymmddhhii your
messages will be added to the outbox and
scheduled to the specified date / time.
datum=201510261215&outboxid=ja
You will receive OK + a unique outboxID in
return which can be used to remove messages
from the outbox at a later time |
|
emailen=nee |
Confirmation by e-mail |
If you
have scheduled a message on a specific
date/time the system will send a
confirmation e-mail after sending.
With this parameter you can disable the
email confirmation |
|
naar=groep&groep=groepnaam |
Send to a group |
You can use the parameter: naar=groep&groep=groepnaam.
The
groupname must be identical to the groupname
in your address book.
You can also combine this with the
date parameter for a dispatch
planned at a later date.
Also see: error 125 and 126 |
|
referentie=12345678 |
Your reference (with a max of 75 characters). |
You can pass on an unique ID which our
system will post back while sending delivery
reports. |
|
test=ja |
Testing the
system |
The system
will conduct all the checks (correct
username, password, message, sendername,
...) but effectively won't send an sms. No
credits will be deducted.
|
|
|
|
|
If your message wasn't send
successfully, the gateway will provide you with an
error + nr. in return. Here you can find a list of
errors:
|
Errorcode |
Explanation |
|
100 |
Username -
value - is empty and cannot be empty |
|
101 |
Password -
value - is empty and cannot be empty |
|
102 |
SMS
message has no content |
|
103 |
Mobile number has no content |
|
104 |
No valid
username and/or password combination |
|
105 |
Message
contains more characters (> 160 character)
then allowed |
|
106 |
No valid
mobile number. A valid number always starts
with the country code followed by the number
: example 44701xxxxxxx |
|
107 |
No valid
countrycode. You cannot send text messages
to this country. Please contact us so we can
make this possible. |
|
108 |
You do not
have sufficiënt credits left |
|
109 |
The sendername is empty |
|
110 |
You are using
a sender number, but it should always start
with the + sign. |
|
111 |
You are using
a non valid sendername/username. This can be
up to 12 characters. |
|
112 |
You are using a non valid country code |
|
113 |
Your
sendername/number contains special
characters not allowed on all networks. |
|
114 |
No valid country code. (country is not
permitted). |
|
115 |
Your account
has been blocked because your payment has
not been received (yet). |
|
116 |
Your account
has been blocked for distinct reasons. You
can contact us for additional information. |
|
117 |
This sendername is not allowed. |
|
118 |
If you want
to send a long text message (> 160 tekens)
this may reach a maximum length of 3
messages, (max 153 characters per message)
so, up to 459 characters maximum. |
|
119 |
For delivery
of text messages to this country, we do not
offer the option of sending long text
messages (> 160 tekens). |
|
120 |
There is a problem with our gateway. Please
contact us. |
|
121 |
You
scheduled a message on a predefined date /
time but the date is in the past or is not
correct! |
|
122 |
You tried
to remove a message from the outbox, but no
matching message was found. |
|
123 |
You tried
to request a report but didn't give a number. |
|
124 |
You tried
to request a report but didn't give a valid
number. eg: number=100 |
|
125 |
You tried
to send a message to a group but we cannot
find this group in your phone list. |
|
126 |
You tried
to send a message to a group but this group
was empty. |
|
150 |
Our
system is down for maintenance temporarily. |
|
|
|
|
In order to receive
the delivery reports, always use the parameter "delivery=yes".
You will receive the answer OK + nr in return .
Example OK 1234567
|
Parameter |
Explanation |
Remark |
|
smsid |
The sms ID |
|
|
datum=ja |
Report date
(dd/mm/yyyy uu:mm:ss) |
If
you provide the parameter
date
=
ja,
our
API
sends
the
status
+
last
update date
/
time
display
Example : DELIVERED 01/02/2012 10:23:10
Note:
|
On this page you can
retrieve the status :
http://217.19.227.48/module/gatewayrapport.php?smsid=1234567
The system provides a code in return according to
the status of the message.
Delivery notification URL :
You can add a
website URL here for having instant delivery reports.
Our system will send a GET request with following
parameters: smsid, datum (date) (yyyymmdduummss),
status, referentie (reference).
Login to your SMS Module, en
look for details under SMS Gateway API
(Example: http://www.mywebsite.com/script.php)
|
Delivery Code |
Explanation |
|
DELIVERED |
The
message was delivered successfully
(endstatus) |
|
NOT DELIVERED |
The
message was not delivered successfully
(endstatus) |
|
BUFFERED |
The
message was accepted by the operator,
but not yet delivered to the recipient.
The operator shall periodically attempt
to deliver the message. This is a
temporary status. |
|
SUBMITTED |
The
message was delivered successfully to
the operator, there is however no status
available (yet). |
|
REJECTED |
The operator has rejected this message
(endstatus) |
|
NONE |
This
message has no delivery report available
and therefore no known status. |
Request
for final delivery reports :
You can
ask the gateway for a realtime group report.
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=rapport&aantal=100
To remove 1 message:
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=verwijderbericht&naar=NUMMER
or
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=verwijderbericht&id=OUTBOXID
To empty de entire outbox:
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=verwijderoutbox
This
action will return : OK or ERROR 122 (no messages
found in the outbox)
|
|
|
|
Request for remaining
amount of credits : You can also retrieve the number
of remaining credits to the gateway:
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=credits
This will return a
certain number : example 476 . This is the number of
credits still remaining in your sms account. |
|
|
|
The above information can also be found inside your
SMS Module. Login with your username & password
and go to "other functons" and
subsequently
tab "SMS
Gateway API" . Of course you can contact us if
you have problems implementing our gateway and API
in your scripting. Questions can be sent to
php-support@1601sms.nl
Would you like
to test
our
gateway
and
unlock
messages
from
your
existing
applications,
please open your private 10 day
testaccount
. Would you like to offer your clientele a
connection over our gateway? Please visit the
Reseller options.
Or
contact
us by phone
and ask your
questions
to our
support
or
sales
staff
+31 (0)84 867 5097
|
|
|
|
Do you
have any questions on implementing your scripts and
do you fancy a call? Please fill in your data and we
will get back to you within short notice. |
|
|