API handleiding Pompoen SMS

Transcriptie

1 Pompoen SMS API handleiding Versie 1.2 Index 1 Uitleg 2 Parameters 3 Optionele parameters 4 Aflever rapportage 5 Credits

2 1. Uitleg Door middel van onze API kunt u onze SMS-toepassing inbouwen in uw eigen systeem, uw website, desktop of mobile applicatie. U kunt een optie inbouwen zodat de benodigde gegevens voor sms-berichten worden verzameld (met bijvoorbeeld een klik op een knop of op een bepaald tijdstip) en dan vanuit uw systeem worden verstuurd. Hiervoor kunt u gebruik maken van onze SMS API dat werkt door middel van een simpele HTTP-request. Wanneer u een HTTP-request naar onze server stuurt, dan kunt u met behulp van POST- of GETvariabelen de waarden meesturen. Bijvoorbeeld de afzender, het bericht en de ontvangers. De parameters die u hiervoor moet gebruiken staan hieronder beschreven.

3 2. Parameters Parameter klantnaam username sha1_password originator message recipients gateway Beschrijving De naam van uw account zoals die in de URL staat die wij voor u aanmaken Uw gebruikersnaam De SHA-1 hash van uw wachtwoord De naam die u als afzender wilt meesturen, bestaande uit maximaal 11 alphanumerieke tekens Het sms-bericht, bestaande uit maximal 160 tekens, URL-gecodeerd De 06-nummers van de ontvangers, gescheiden door een komma 1 (vaste waarde) 9f878a968e4f6db7d403&originator= Pompoen&message=SMS-voorbeeld.++Test+123&recipients= , &gateway=1

4 3. Optionele parameters deliverydate aflevertijdstip, aan te geven als als yyyymmddhhmmss (bijvoorbeeld voor het versturen op 23 maart 2012 om 11:30 uur precies) cut automatisch berichten na 160 karakters afknippen, aan te geven als true of false replace_illegal_chars non-gsm karakters vervangen door alternatieve karakters, aan te geven als true of false (zie hieronder voor uitleg) Non-GSM karakters: Voor het versturen van SMS-berichten wordt standaard de GSM charset gebruikt. Helaas komen veel karakters niet voor in de GSM-charset. Om u hiervan zo min mogelijk last te laten hebben, worden standaard alle karakters die niet voorkomen in de GSM-charset omgezet naar aanverwante karakters. Zo wordt bijvoorbeeld ç omgezet om naar c; ë naar e en naar R. Dit gebeurt bij het bericht en bij de afzender (indien alfanumeriek). Als er karakters vervangen zijn, wordt dit in het resultaat vermeldt. <response> <item type="sms"> <resultmessage>message succesful sent. Replaced 2 characters which are not in the GSM charset.</resultmessage> </item> </response>

5 4. Afleverrapportage Na het versturen van een sms wordt er een XML-resultaat gegenereerd met de status van het verstuurde bericht. <response> <item type="succes"> <code>10</code> <message>succesfully sent 1 message(s).</message> </item> </response> Resultaatcodes: Parameter Beschrijving Bericht(en) succesvol verzonden Geen 'username' opgegeven Geen 'password' opgegeven Geen 'originator' opgegeven Geen 'recipients' opgegeven Geen 'message' opgegeven Geen juiste 'recipients' opgegeven; aantal tekens van telefoonnummer(s) klopt mogelijk niet Geen juiste 'originator' opgegeven; mogelijk teveel tekens (max. 11) Geen juiste 'message' opgegeven; mogelijk teveel tekens (max. 160) of onjuiste URL-codering Probleem met charset Andere parameterfout Incorrecte 'username' of 'password' Onvoldoende credits beschikbaar Gateway onbereikbaar Onbekende fout

6 5. Credits Het aantal credits dat u gebruikt, wordt automatisch van uw tegoed afgeschreven. Als u wilt weten hoeveel credits u nog in uw tegoed heeft, dan kunt u dat ook opvragen met een HTTP-request f878a968e4f6db7d403 Als resultaat krijgt u een XML-response zoals hieronder terug. <response> <item type="succes"> <credits>75.0</credits> </item> </response>