Hi, welkom bij de documentatie voor de Spryng PHP Api Library. Deze handleiding biedt praktische informatie over het integreren van de library. Voor meer informatie kunt u gebruik maken van de PHPDoc in deze repository.

Installatie en initialisatie

Met Composer

We raden u aan de library te installeren met Composer. Dit kan op de volgende manier:

composer require spryng/spryng-api-http-php

Zodra de installatie voltooid is, kunt u Spryng op de volgende manier initialiseren:

require ( 'vendor/autoload.php' );
 use SpryngApiHttpPhp\Client;
 $spryng = new Client('gebruikersnaam', 'wachtwoord', 'Uw Bedrijf');

Zonder Composer

Installatie zonder Composer wordt niet aangeraden! De library maakt gebruik van enkele dependencies, zoals GuzzleHttp, die niet kunnen worden geïnstalleerd met een autoloader.

Als u geen gebruik maakt van Composer, bijvoorbeeld door technische beperkingen, kunt u gebruik maken van de autoloader om alle klassen in te laden.

$ git clone https://github.com/spryng/SpryngApiHttpPhp.git

require ( 'SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php' );
 use SpryngApiHttpPhp\Client;
 $spryng = new Client( 'gebruikersnaam', 'wachtwoord', 'Uw Bedrijf' );

Een SMS versturen

U kunt SMS berichten versturen met de methode Client $spryng->sms->send(). Deze methode heeft de volgende argumenten:

• $recipient Het telefoonnummer waar u een SMS naar wilt versturen.
• $body Het SMS bericht.
• $options Verdere opties zoals allowlong en route.

Opties

Er zijn enkele opties die u kunt specificeren bij het versturen van een SMS bericht. De restricties voor deze opties zijn te vinden in de algemene beschrijving van de Spryng SMS Api.

• • route De route die u wilt gebruiken. Deze wordt u aangeleverd.
  • reference Een optionele referentie voor uw bericht. Deze kunt u gebruiken om delivery reports te ontvangen.
  • allowlong Boolean waarde waarmee u aangeeft of berichten langer dan 160 tekens in verschillende berichten verzonden mogen worden.

Volledig voorbeeld

require ( 'vendor/autoload.php' );

use SpryngApiHttpPhp\Client;
use SpryngApiHttpPhp\Exception\InvalidRequestException;

$spryng = new Client('gebruikersnaam', 'wachtwoord', 'Uw Bedrijf' );

try {
    $spryng->sms->send('32612345678', 'Een voorbeeld bericht!', array(
        'route' => 'business',
        'allowlong' => true,
        'reference' => 'ABC123456789')
    );
}
catch (InvalidRequestException $e)
 {
    echo $e->getMessage();
 }

Aanvragen credit balans

Naast het versturen van SMS berichten, is het ook mogelijk om uw credit balans op te vragen. Deze methode heeft geen extra argumenten nodig en kan als volgt worden geïmplementeerd:

require ( 'SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php' );
use SpryngApiHttpPhp\Client;
$spryng = new Client( 'gebruikersnaam', 'wachtwoord', 'Uw Bedrijf' );
echo 'Huidige balans: ' . $spryng->sms->checkBalance();

API

De Spryng SMS-MT HTTP API ondersteunt HTTP POST met een Content-Type ‘application/x-www-form-urlencoded’ via HTTPS. Bij vragen over de Spryng SMS-MT HTTP API kunt u een e-mail sturen naar onze support afdeling via info@spryng.nl.

Koppelen aan de gateway

Om een bericht te verzenden kan er een HTTP POST call uitgevoerd worden naar het volgende adres:
https://api.spryngsms.com/api/send.php

Parameters

Username

Gekozen door gebruikers bij aanmelding op https://www.spryng.nl

Secret

Door gebruiker te genereren in de profielpagina op https://login.spryngsms.com/portal/account

References

Destination

Nummer(s) bestemming

Sender

Afzender van het bericht

Body

Inhoud van de SMS

Service

Referentie tag kan gebruikt worden om een filter in statistieken te creëren.

Route

Om de Spryng Business, Spryng Economy of Specific User route te selecteren.

Allowlong

Als u Long SMS wenst te versturen

Return Values

Delivery Reports

U kunt uw delivery reports instellen door in te loggen op uw account op https://www.spryng.nl en door “instellingen” in uw SMS Dashboard te selecteren. Hier kunt u de URL van uw script (servlet, php script, perl, etc…) invoeren waar u uw delivery reports op wenst te ontvangen. Dit script zou 2 parameters moeten bevatten, welke verstuurd wordt via een HTTP GET. Wanneer u een delivery report aanvraagt, moet u niet meer dan 1 DESTINATION specificeren in het verzoek. De volgende status waardes zullen verzonden worden:

Voorbeeld: REFERENCE=abc123&STATUS=10

Het HTTP verzoek uitgevoerd door Spryng moet beantwoord worden door uw server met de status code 200, wat betekent dat het bericht succesvol is geaccepteerd door uw systeem. Wanneer de HTTP server niet bereikt kan worden en als het bijvoorbeeld terugkomt met 500 internal server error, neemt Spryng aan dat het bericht niet succesvol is geaccepteerd door uw systeem en het verzoek zal eenmaal per minuut opnieuw verzonden worden. Het bericht zal niet eeuwig opnieuw verzonden worden, de huidige instelling is 24 uur.

Field types

Numeriek: karakters 0 tot 9 Alfanumeriek: karakter van ISO-8859-1
MSISDN-numeriek karakters 0 tot 9 GSM 7-bit alfabet (toegestane karakters in tekst berichten): de karakters ‘a‘ tot en met ‘z‘, ‘A‘ tot en met ‘Z‘,
‘0‘ tot en met ‘9‘, linefeed, carriage return en
@£$¥èéùìòÇØøÅå_€ÆæßÉ!”#¤%&'()*+,-./:;<=>?¡ÄÖÑܧ¿äöñüà
Om het €  teken te gebruiken, moet u %80 invoeren. Als u daadwerkelijk het euroteken gebruikt geldt deze als 2 karakters:
€ = 2 karakters
E = 1 karakter

Credit amount API

POST https://api.spryngsms.com/api/check.php