SMS batches versturen via XML-API
Versturen van SMS batches
Deze API werkt middels een HTTP request. Wanneer u een HTTP request naar onze server stuurt, kunt u met behulp van de POST-body een XML-document meesturen. In het document kunt u verschillende berichten specificeren die dan in een keer door ons SMS-platform worden verwerkt. U kunt bijvoorbeeld 200 gepersonaliseerde berichten met één aanroep versturen.
Let op: Het is niet mogelijk om Premium SMS te versturen via deze XML-API.
Post het XML-document naar deze URL:
https://www.mollie.nl/xml/sms.xml
Voorbeeld SMS in XML 1:
<?xml version="1.0" encoding="UTF-8" ?>
<text_message>
<username>[API gebruikersnaam]</username>
<password>[API wachtwoord]</password>
<messages>
<message reference="[referentie]">
<originator>[afzender]</originator>
<recipients>
<recipient>[ontvanger]</recipient>
</recipients>
<body>[bericht]</body>
</message>
</messages>
</text_message>
Voorbeeld SMS in XML 2:
<?xml version="1.0" encoding="UTF-8" ?>
<text_message>
<username>[API gebruikersnaam]</username>
<password>[API wachtwoord]</password>
<options><option name="return_charged_information"
value="TRUE" /></options>
<messages>
<message reference="[referentie]">
<gateway>[gateway id]</gateway>
<originator>[afzender]</originator>
<recipients>
<recipient>[ontvanger 1]</recipient>
<recipient>[ontvanger 2]</recipient>
</recipients>
<udh>[binary header]</udh>
<body>[binary bericht]</body>
</message>
</messages>
</text_message>
Nodes van <text_message>
| Node | Uitleg | Opmerkingen |
|---|---|---|
| username | mollie.nl API gebruikersnaam | |
| password | mollie.nl API wachtwoord | |
| messages | de verzameling van berichten | bevat 1 of meer <message>-nodes |
| Optionele nodes | ||
| dlrurl | alternatieve url voor afleverrapportage | meer over rapportages » |
| options | extra opties, bijv. extra info terugvragen in terugkoppeling | optie: return_charged_information |
Nodes van <message>
| Node | Uitleg | Opmerkingen |
|---|---|---|
| originator | afzender van het bericht | maximaal 14 cijfers of 11 tekens |
| recipients | de verzameling van ontvangers van het bericht | bevat 1 of meer <recipient>-nodes |
| body | het bericht | maximaal 160 tekens (tenzij long sms of binary) |
| Optionele attributen | ||
| reference | nodig voor afleverrapportage | meer over rapportages » |
| Optionele nodes | ||
| gateway | welke SMS-route er gebruikt moet worden | Wat moet hier meegegeven worden? |
| deliverydate | lever bericht af op een bepaald tijdstip | formaat: yyyymmddhhmmss |
| type | soort SMS-bericht | normal / wappush / vcard / flash / binary / long |
| udh | de 'header' van het SMS-bericht | alleen bij type=binary |
Verwerken van de response
Na het sturen van de HTTP-request geeft onze server een XML-resultaat terug. Hieronder vind je een voorbeeld:
<?xml version="1.0"?>
<response>
<total_messages>1</total_messages>
<total_recipients>1</total_recipients>
</response>
Het totaal aantal berichten wordt teruggegeven als total_messages. Het item total_recipients geeft in het geval dat het versturen gelukt is het aantal telefoonnummers aan waarnaar de berichten verstuurd zijn. Nummers die duidelijk geen telefoonnummer zijn worden door ons systeem gefilterd.
Bij foutmeldingen wordt de XML resultcode-structuur van de HTTP-API aangehouden. Mogelijke resultaten uit resultcode:
- 20 - geen 'username' opgegeven
- 21 - geen 'password' opgegeven
- 22 - geen of onjuiste 'originator' opgegeven
- 23 - geen 'recipients' opgegeven
- 24 - geen 'message' opgegeven
- 25 - geen juiste 'recipients' opgegeven
- 26 - geen juiste 'originator' opgegeven
- 27 - geen juiste 'message' opgegeven
- 28 - probleem met charset
- 29 - andere parameter fout
- 30 - incorrecte 'username' of 'password'
- 31 - onvoldoende credits om te versturen
- 98 - gateway onbereikbaar
- 99 - onbekende fout
SMS XML API downloads
Hieronder plaatsen wij classes, modules en voorbeelden.
| Omschrijving | Programmeertaal | Auteur | Versie |
|---|---|---|---|
| PHP class | PHP 5.x of hoger | Mollie | v1.1 (01/04/11) |