Hi, welcome to the documentation for the Spryng PHP API Library. This guide contains practical information on how to use the library. Full PHPDOC can be found this repository.

Installation and initialization

Using Composer

The easiest way to install the libary is using composer:

composer require spryng/spryng-api-http-php

When the installation is complete, you can initialize Spryng as follows:

require ( 'vendor/autoload.php' );
 use SpryngApiHttpPhp\Client;
 $spryng = new Client('username', 'password', 'My Company');

Without Composer

If you’re not yet using composer, you can use the autoloader:

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

require ( 'SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php' );
 use SpryngApiHttpPhp\Client;
 $spryng = new Client( 'username', 'password', 'My Company' );

Sending SMS

To send an SMS, you should use the $spryng->sms->send() method. This method uses the following parameters:

• $recipient Phone number you’re sending the sms to.
• $body Body of the SMS.
• $options Additional parameters like allowlong and route.

Options

There are a number of options you can specify with your request. The requirements for these options are available in the general documentation.

• • route Enter your assigned route.
  • reference An optional reference for delivery reports.
  • allowlong Whether you want to allow Long SMS or not. Should be true or false.

Full example

require ( 'vendor/autoload.php' );

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

$spryng = new Client('username', 'password', 'My Company');

try {
    $spryng->sms->send('33612345678', 'A sample message!', array(
        'route' => 'business',
        'allowlong' => true,
        'reference' => 'ABC123456789')
    );
}
catch (InvalidRequestException $e)
 {
    echo $e->getMessage();
 }

Requesting credit balance

Alongside the ability to send SMS messages, it’s also possible to request your current credit balance. This method does not require any parameters and can be used as follows:

require ( 'SpryngApiHttpPhp/src/Spryng/Api/Autoloader.php' );
use SpryngApiHttpPhp\Client;
$spryng = new Client( 'username', 'password', 'My Company' );
echo 'Huidige balans: ' . $spryng->sms->checkBalance();

API

The Spryng SMS-MT HTTP API supports HTTP POST with a Content-Type of ‘application/x-www-form-urlencoded’ via HTTPS. If you have any questions about the Spryng SMS-MT HTTP API please send an email to our support department at info@spryng.fr.

Connecting to the gateway

To submit a SMS a HTTP POST call can be performed to the following address: https://api.spryngsms.com/api/send.php

Parameters

Username

Chosen by user when signing up on http://www.spryng.fr

Secret

To be generated by user on his profile page on https://login.spryngsms.com/portal/account

Reference

Destination

Destination number(s)

Sender

Originator address

Body

Content of SMS

Service

Reference tag can be used to create a filter in statistics

Route

To select the Spryng Business, Spryng Economy or Specific User route.

Allowlong

If you wish to send Long SMS

Return Values

Delivery Reports

You can set your delivery reports by logging on to your account on http://www.spryng.fr and selecting the menu item ‘Settings’ in your SMS dashboard. Here you can enter the url of your script (servlet, php script, perl, etc…) on which you wish to receive your delivery reports. This script should expect two parameters, this will be sent via an HTTP GET. When you require a delivery reports you should not specify more than 1 DESTINATION in the request. The following status values will be sent:

Example: REFERENCE=abc123&STATUS=10

The HTTP request conducted by Spryng must be answered by your server with a status code of 200 which means that the message was successfully accepted by your system. If either the HTTP server cannot be reached, if it returns e.g. 500 internal server error Spryng assumes that the message was not successfully accepted by your system and the request will be retried once every minute. The message will not be retried forever, the current setting is 24 hours.

Field types

Numeric: characters 0 to 9 Alphanumeric: character from ISO-8859-1 MSISDN-numeric characters 0 to 9 GSM 7-bit alphabet (allowed characters in text messages): The characters ‘a‘ through ‘z‘, ‘A‘ through ‘Z‘,
‘0‘ through ‘9‘, linefeed, carriage return and @£$¥èéùìòÇØøÅå_€ÆæßÉ!”#¤%&'()*+,-./:;<=>?¡ÄÖÑܧ¿äöñüà
To use the € sign please use %80.
If you are using the euro sign, this will count as 2 characters:
€ = 2 characters
E = 1 character

Credit amount API

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