|
|
De
SMS Gateway API
van
1601SMS is een flexibele online omgeving voor
effectieve communicatie via SMS. Verstuur vanuit
uw eigen applicatie berichten naar onze SMS
Gateway, die de berichten automatisch omzet en
als SMS aflevert. Log in op de
gebruiksvriendelijke online interface van de SMS
Gateway en verstuur SMS berichten naar
verschillende doelgroepen, of koppel uw eigen CRM-pakket aan onze SMS
Gateway. Wanneer u als software aanbieder
interesse heeft SMS mogelijkheden te integreren in bijv. uw ( CRM ) pakket, bekijk dan onze
Reseller
mogelijkheden.
|
|
|
|
Enkele toepassingen voor het gebruik van onze
Gateway API zijn;
❶
Planning- of voorraad systeem koppelen aan SMS.
Informeer uw klanten per SMS over de status
van orders
❶
SMS diensten integreren om uw website
interactiever te maken: Denk hierbij aan een
routebeschrijving, contactinformatie of het
laatste nieuws per SMS
❶ Het
stroomlijnen van interne
bedrijfsprocessen, afspraken bevestiging voor uw verkoopteam,
belangrijke mededelingen doen, notificatie krijgen uw als server
down is etc...
❶
Wanneer u als software aanbieder interesse heeft
SMS mogelijkheden te integreren in bijv. uw (
CRM ) pakket, bekijk dan onze
Reseller mogelijkheden.
|
|
|
|
|
URL aanspreken
De 1601SMS message gateway
staat in verbinding met alle Nederlandse
SMS-Centrales zodat een goede Quality of Service
(beschikbaarheid, capaciteit en snelheid) voorhanden
is. De meest gebruikte methode om berichten via onze
message gateway te versturen of te ontvangen is via
het HTTP GET protocol.
Via een HTTP request (GET of POST) kunt u onze
gateway aanspreken via uw eigen software applicatie.
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&bericht=BERICHT&naar=NAAR&afzender=SENDER
(simpele test) - Wanneer
u bovenstaande string in uw browser invoert, uw Username en Password
ingeeft, kunt u gemakkelijk
via deze url, bulk sms berichten versturen. Wanneer u 31612345678,31612345677
toevoegt, slechts gescheiden door een komma, verstuurt u naar meerdere mobiele nummers.
Open hier een
testaccount
om dit te proberen.
|
Antwoord |
Uitleg |
Opmerking |
|
OK |
Uw sms werd succesvol
verzonden |
Uw SMS werd succesvol
verzonden |
|
ERROR xxx |
Er was een probleem +
errorcode |
Een overzicht van mogelijke
errorcodes kunt u
hieronder terugvinden. |
|
|
|
|
U moet de bovenstaande url steeds encoderen voordat
u deze verzend omdat deze o.a. geen spaties mag
bevatten.
Bvb : bericht=dit is een test , dit moet in de
praktijk worden : bericht=dit%20is%20een%20test
In PHP is hier een zeer eenvoudige functie voor :
urlencode($url);
Dit moet ook gebeuren voor de afzendernaam indien u
hierin een spatie wil gebruiken of andere speciale
tekens !
UTF-8
(8-
bit
Unicode Transformation Format) is een manier
om
Unicode/ISO 10646-tekens op te slaan als een stroom van
bytes, een zogenaamde
tekencodering. UTF-8 is een tekencodering met
een variabele lengte: niet elk teken gebruikt
evenveel bytes. Afhankelijk van het teken worden
tussen 1 en 4 bytes gebruikt. Omdat veel westerse
letters slechts 1 byte in beslag nemen, is UTF-8
voor westerse talen compacter. Wanneer u via onze
gateway verstuurt, zorg er dan voor dat
uw bericht (bericht) en de afzendernaam (sender)
UTF-8 geëncodeerd is. U kunt UTF8 encodering overigens
gemakkelijk testen via deze pagina:
http://www.hypergurl.com/urlencode.html
;
let op: encoding op UTF8 zetten, en niet op ASCII
De 1601SMS
gateway ondersteunt het gebruik van alfanummerieke
afzenders (letters en/of cijfers). In plaats van een
telefoonnummer ziet de ontvanger van het bericht een
tekst - van maximaal 11 karakters - als afzender. |
|
|
|
|
Programmeertaal |
Naam |
Uitleg |
|
PHP |
Fsockopen
 |
Hier kunt u informatie terugvinden over Fsockopen, een PHP functie voor het
aanspreken van een url. |
|
PHP |
Urlencode
|
Hier kunt u informatie terugvinden of urlencode, een PHP functie voor het
encoderen van een url. |
|
VB.net |
easyHTTP
|
Hier kunt u informatie terugvinden voor
het aanspreken van de gateway via VB.net |
|
Een PHP
Voorbeeld |
PHP voorbeeld
|
Hier ziet u een werkend PHP voorbeeld : |
Translate this page in English |
|
|
|
|
Parameter |
Uitleg |
Opmerking |
|
klantuser |
uw gebruikersnaam |
Hetzelfde als u ontvangen
heeft voor de sms module |
|
klantpwd |
uw wachtwoord |
Hetzelfde als u ontvangen
heeft voor de sms module ( u kunt dit
wachtwoord ook encoderen met
SHA-1
voor extra
veiligheid. ( enkel het gebruik van 1 - case
karakters is overigens toegestaan ) |
|
bericht |
het SMS bericht |
Let op : het bericht moet
urlencoded zijn vooraleer u verstuurd. (dit
is een test = dit%20is%20een%20test) |
|
naar |
het gsmnummer |
Een geldig sms nummer (steeds
beginnen met de juiste landcode : bvb
32478123456) |
|
afzender |
de afzendernaam |
maximaal 11 tekens
(afzendernaam) |
|
|
|
|
|
Optionele parameters |
|
logging=ja |
Loggingsfunctie |
|
Indien u logging=ja toevoegd
zullen alle smsverzendingen automatisch
opgeslagen worden in de historiek van de sms
module. |
|
delivery=ja |
Afleverrapporten |
Indien u delivery=ja toevoegd
krijgt u bij een succesvolle verzending OK +
een smsID terug.
bvb : OK 1234567
U kan dit SMS ID opvangen en kunt hier een
callback action op uitvoeren om het rapport
op te vragen. |
|
datum=yyyymmddhhii |
SMS inplannen op specifieke datum/tijd |
Indien u verstuurdatum=yyyymmddhhii gebruikt
worden uw smsjes ingepland op de opgegeven
datum/tijd.
Let op :
- alleen data in de toekomst zijn
toegestaan.
- vul altijd alle velden volledig in (bvb
201206152000)
(een jaartal altijd in 4 cijfers , maand,
dag, uur en minuut altijd met 2 cijfers!)
- uw berichten komen te staan in de outbox
van de sms module en kunt u nog verwijderen
indien gewenst.
- mogelijk uren zijn van 0 tot 23 ;
mogelijke minuten zijn 00 , 15 , 30 , 45
U kunt nog een 2de parameter meegeven: vb:
datum=201510261215&outboxid=ja
U krijgt dan OK + unieke outboxID terug die
u kunt gebruiken om later berichten terug te
verwijderen uit de outbox. |
|
emailen=nee |
Bevestiging e-mail versturen |
Indien u een SMS inpland op een specifieke
datum stuurt het systeem standaard een
e-mail wanneer de SMS verzonden werd.
Met deze parameter kunt u deze
bevestigingsemail uitschakelen. |
|
naar=groep&groep=groepnaam |
Versturen naar een groep |
U heeft uw gsmnummers is ons systeem staan
maar wilt toch via de API een koppeling
maken naar deze groepen? Dat kan op deze
manier:
U gebruikt de parameters: naar=groep&groep=groepnaam.
Groepnaam moet overeenkomen
met een groepnaam uit uw adressenlijst.
(gebruik hiervoor best geen spaties en/of
speciale tekens in uw adressenlijst).
U kunt dit ook combineren met de
datum parameter om een
groepsverzending in te plannen op een later
tijdstip.
Zie ook: error 125 en 126 |
|
type=long |
Versturen van lange berichten |
Indien u type=long toevoegd
kan u berichten > 160 tekens versturen. Het
bericht wordt in dit geval opgesplitst in
meerdere SMS-berichten en vervolgens op de
telefoon als één bericht weergegeven. U kan
een bericht aanleveren tot maximum 459
tekens en wij splitsen het op naar maximaal
3 SMS-berichten. Let op : je kan per SMS
maar 153 tekens gebruiken (de andere 7
tekens worden gebruikt om aan te geven dat
het om een "long SMS" gaat). |
|
test=ja |
Testen van het systeem |
Het systeem zal wel alle
controles uitvoeren (correcte
gebruikersnaam,wachtwoord ,bericht,
afzendernaam, ...) maar zal geen effectieve
SMS versturen. Er worden ook geen credits
afgetrokken. |
|
referentie=12345678 |
Uw
referentie (maximaal 75 tekens). |
U
kunt hier een unieke ID meegeven die u bij
het ontvangen een afleverrapport terugkrijgt
van ons systeem.
|
|
|
|
|
Als uw bericht niet succesvol
verzonden is geeft de gateway een error + nr terug.
Hier kunt u een overzicht terugvinden van de errors.
|
Errorcode |
Uitleg |
|
100 |
Gebruikersnaam-waarde is leeg
en mag niet leeg zijn |
|
101 |
Wachtwoord-waarde is leeg en
mag niet leeg zijn |
|
102 |
SMS bericht bevat geen inhoud |
|
103 |
Gsmnummer bevat geen inhoud |
|
104 |
Geen geldige gebruikersnaam
en/of wachtwoord combinatie |
|
105 |
Bericht bevat meer tekens dan
toegestaan (> 160 tekens) |
|
106 |
Geen geldig GSMnr. Een geldig
nummer start altijd met de landcode gevolgt
door het nummer : bvb 31612345678 |
|
107 |
Geen geldige landcode. U kan
geen smsjes versturen naar dit land. Gelieve
ons te contacteren of we dit mogelijk kunnen
maken. |
|
108 |
U heeft niet voldoende
credits meer |
|
109 |
De afzendernaam is leeg |
|
110 |
U maakt gebruik van een
afzendernummer, maar deze moet altijd met
een +teken beginnen. |
|
111 |
U maakt gebruik van een
ongeldige afzendernaam/nummer. Deze mag
maximaal 12 tekens bevatten. |
|
112 |
U maakt gebruik van een
ongeldige landcode |
|
113 |
Uw afzendernaam/nummer bevat
speciale tekens die niet op alle netwerken
zijn toegelaten. |
|
114 |
Geen geldige landcode (land
niet toegestaan). |
|
115 |
Uw account werd geblokkeerd
omdat uw betaling nog niet in orde is. |
|
116 |
Uw account werd geblokkeerd
om een bepaalde reden. U kan contact met ons
opnemen voor meer informatie. |
|
117 |
Deze afzendernaam is niet
toegestaan. |
|
118 |
Indien u een lange SMS wil
versturen (> 160 tekens) mag deze maximaal 3
berichten lang zijn, (max 153 tekens per
bericht) dus maximaal 459 tekens lang. |
|
119 |
Voor versturen van smsjes
naar dit land , kan u de mogelijkheid om
lange smsjes (> 160 tekens) te versturen
niet gebruiken. |
|
120 |
Er was een probleem met onze
gateway. Gelieve ons te contacteren. |
|
121 |
U maakt gebruik van een verzending op vooraf
opgegeven datum/tijd maar de datum ligt in
het verleden of is niet juist ! |
|
122 |
U probeerde een SMS bericht uit de outbox te
verwijderen maar er werd geen overeenkomstig
bericht gevonden. |
|
123 |
U probeerde een rapport te halen uit het
systeem maar gaf geen aantal op. |
|
124 |
U probeerde een rapport te halen uit het
systeem maar het aantal was niet geldig. vb:
aantal=100 |
|
125 |
U probeerde een SMS naar een groep te
versturen maar deze groep kunnen we echter
niet terugvinden in uw telefoonlijst. |
|
126 |
U probeerde een SMS naar een groep te
versturen maar deze groep bevat geen
gsmnummer. |
|
150 |
Onze module is tijdelijk
buiten gebruik wegens werkzaamheden. |
Translate this page in English |
|
|
|
Om afleverrapporten te gebruiken moet
u altijd eerst de parameter "delivery=ja" gebruiken.
U krijgt dan als antwoord OK + nr terug . bvb OK
1234567
|
Parameter |
Uitleg |
Opmerking |
|
smsid |
Het sms ID |
Het unieke ID van het bericht waarvan u
het afleverrapport wenst op te vragen |
|
datum=ja |
Rapport datum
(dd/mm/yyyy uu:mm:ss) |
Indien u
parameter datum=ja meegeeft zal onze API de
status + laatste update datum/tijd
weergeven.
Bvb : DELIVERED 01/02/2012 10:23:10
Let op: indien het bericht nog onderweg is (SUBMITTED)
of er geen rapport beschikbaar is (NONE) is
er geen afleverrapportdatum beschikbaar. |
Via deze pagina kan u de statussen
opvragen :
http://217.19.227.48/module/gatewayrapport.php?smsid=1234567
Het systeem geeft een code terug naargelang de
status van het bericht.
Afleverrapporten ontvangen op een
API
Ook kunt u een URL opgeven waarnaar wij
afleverrapporten sturen. Ons systeem zal een GET
uitvoeren op dit script met volgende parameters:
smsid, datum (yyyymmdduummss), status, referentie.
Login in uw SMS Module, en kijk voor details onder
SMS Gateway API
(Voorbeeld: http://www.mijndomein.com/mijnscript.php)
|
Aflevercode |
Uitleg |
|
DELIVERED |
Het bericht werd
succesvol afgeleverd (eindstatus) |
|
NOT DELIVERED |
Het bericht werd niet
succesvol afgeleverd (eindstatus) |
|
BUFFERED |
Het bericht werd
geaccepteerd door de operator, maar nog
niet afgeleverd aan de ontvanger. De
operator zal op regelmatige tijdstippen
proberen dit bericht af te leveren . Dit
is een tijdelijke status. |
|
SUBMITTED |
Het bericht werd
succesvol afgeleverd aan de operator, en
er is (nog) geen status beschikbaar van
het bericht. |
|
REJECTED |
De operator heeft dit
bericht geweigerd (eindstatus) |
|
NONE |
Van dit bericht is er
geen afleverrapport (meer) beschikbaar
en dus ook geen status bekend. |
Rapport laatste
verzendingen opvragen :
U
kunt via de gateway ook een realtime groepsrapport
opvragen.
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=rapport&aantal=100
Deze actie geeft een tabel terug met de laatste 100
verzonden berichten, in tabelvorm, met hierbij hun
afleverrapport.
U kunt via de
gateway ook de berichten uit uw outbox beheren.
Om 1 bericht te verwijderen:
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=verwijderbericht&naar=NUMMER
of
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=verwijderbericht&id=OUTBOXID
Om de gehele outbox leeg te maken:
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=verwijderoutbox
Deze actie geeft
terug : OK of ERROR 122 (geen bericht gevonden in
outbox)
Translate this page in English |
|
|
|
U kunt ook uw aantal resterende
credits opvragen aan de gateway.
http://217.19.227.48/module/gateway.php?klantuser=USERNAME&klantpwd=PASSWORD&action=credits
Dit geeft een getal terug : bvb 476
Dit is het aantal credits dat u nog op uw SMS
account heeft staat. |
|
|
|
Bovenstaande informatie vindt u ook
in uw SMS Module. Login met uw username & password
en ga naar "extra functies" en vervolgens naar "SMS
Gateway API" . U kunt ons
vanzelfsprekend contacteren als u
problemen heeft met het implementeren van onze gateway in uw scripts.
Stuur eventuele vragen / scripts naar
php-support@1601sms.nl
Wilt u onze gateway eens testen en
berichten ontsluiten vanaf uw bestaande applicaties,
open dan even een
testaccount
,
en gebruik de via de mail te ontvangen
gebruikersnaam- en wachtwoord gegevens als
identificatie in uw scripts.
Wilt u uw klanten een connectie met onze gateway
bieden, bekijk dan onze
Reseller mogelijkheden. Of neem voor vragen telefonisch even contact op met onze support- of sales medewerkers...
+31 (0)84 0030 530
|
|
|
|
Heeft
u vragen over integratie van uw scrips en wilt u
gebeld worden? Vul hieronder uw gegevens in en wij
nemen vervolgens z.s.m. contact met u op. |
|
|