Développeurs

Utilisez notre API pour facilement intégrer ou développer des services.

Introduction

Spryng délivre une demande HTTP POST pour un script sur votre serveur à chaque fois qu’un message provenant d’un mobile (MO) arrive. Vous devez définir un script qui peut traiter des données HTTP POST pour recevoir les demandes.

La demande HTTP donnée par Spryng doit recevoir une réponse HTTP par votre serveur avec un code de statut 200, ce qui signifie que le message a été accepté avec succès par votre système. Si le serveur HTTP ne peut pas être atteint, s’il répond par exemple 500 erreur interne du serveur Spryng présume que le message n’a pas été accepté avec succès par votre système et la demande sera réessayée une fois toutes les minutes. L’envoi du message ne sera pas réessayé tout le temps, elle sera effectuée pendant 24h.

Recevoir des messages provenant de Spryng

Exemple pour un script PHP

class MOGateway
{
      $log = "MO RECEIVED. REQUEST: " .
              "Originator MSISDN: " .     $_GET['MSISDN'] .
              "First word (keyword) " .   $_GET['KEYWORD'] .
              "Message content: " .       $_GET['PARM'] .
              "Receiver's operator: " .   $_GET['OPERATOR'] .
              "Received at: " .           $_GET['TIMESTAMP'] .
              "Shortcode: " .             $_GET['SHORTCODE'] .
              "Country code: " .          $_GET['COUNTRY'];


      $db->query('UPDATE texts SET received = 1 WHERE msisdn = :msisdn;', array('msisdn' => $_GET['MSISDN']));

      echo 'TRUE';
  }
}

Paramètres

Paramètre
MSISDN Le numéro de téléphone depuis lequel la réponse provient
KEYWORD Le mot-clé avec lequel le message commence
PARM L’ensemble du texte du message situé après le mot-clé
OPERATOR Le code de réseau du MSISDN
TIMESTAMP Temps que le message met pour être reçu par SMSC ou par le système
SHORTCODE Le shortcode auquel la réponse a été envoyée
COUNTRY Le code de pays à trois lettres (ISO 3166-1 alpha-3)

MSISDN

Le numéro de téléphone dont la réponse est originaire

Type MSISDN-numérique (Format international sans  “00” ou “+”)
Longueur Min 1 MSISDN
Longueur Max 1 MSISDN
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple MSISDN=33612345678

KEYWORD

Le mot-clé avec lequel le message commence. Les caractères seront encodés Url.

Type Alphanumérique
Longueur Min 2
Longueur Max 15
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple KEYWORD=WIN

PARM

L’ensemble du texte du message situé après le mot-clé. Les caractères seront encodés Url.

Type Alphanumérique
Longueur Min <na>
Longueur Max <na>
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple PARM=ON

OPERATOR

Code réseau du MSISDN. Les codes réseau des autres pays peuvent être trouvé sur le site suivant: http://www.mcc-mnc.com/.

Type Numérique
Longueur Min 5
Longueur Max 5
Valeur Min <na>
Valeur Max <na>
Valeurs Voir annexe B
Valeur par défaut OPERATOR=20408
Exemple MSISDN=33612345678

TIMESTAMP

Temps que le message met pour être reçu par SMSC ou s’ils n’ont pas été fournis; temps qu’il entre en contact avec notre système. Voir annexe A des types de champ.

Type Temps
Longueur Min 14
Longueur Max 14
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple TIMESTAMP=20040208152544

SHORTCODE

Le shortcode auquel la réponse a été envoyée.

Type Numérique (format national)
Longueur Min <na>
Longueur Max <na>
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple SHORTCODE=4414

COUNTRY

Le code de pays à trois lettres ISO 3166-1 alpha-3. Une liste des ISO 3166-1 alpha-3 codes couramment utilisé est disponible sur  http://fr.wikipedia.org/wiki/ISO_3166-1_alpha-3.

Type Alphanumérique (ISO 3166-1 alpha-3)
Longueur Min 3
Longueur Max 3
Valeur Min ABW
Valeur Max ZWE
Valeurs ISO 3166-1 alpha-3
Valeur par défaut <none>
Exemple COUNTRY=FR

Field types

Type Valeurs
Numeric caractères 0 à 9
Alphanumeric caractère de l’ISO-8859-1
MSISDN-numeric caractères 0 à 9, Le premier caractère doit être un signe ‘+’
Time temps comme YYYYMMDDHHMMSS

Network codes

Ci-dessous la liste des codes réseau couramment utilisé pour les paramètres OPERATEUR.

Opérateur Code réseau
Belgique
Proximus 20601
Mobistar 20610
Base 20620
France
Bouygues Telecom 20820
Orange 20801
SFR 20810
Allemagne
T-Mobile 26201
E-Plus 26203
Mobilcom 26213
O2 26207
Vodafone 26202
Espagne
Orange 21403
Telefonica 21407
Vodafone 21401
Pays-Bas
KPN Mobile 20408
Vodafone 20404
T-Mobile 20416
Telfort 20412
Orange 20420
Tele2 20402
Turquie
Avea 28604
Vodafone 28602
Turkcell 28601
Royaume-Uni
3 23420
O2 23410
Orange 23433
T-Mobile 23430
Vodafone 23415

Introduction

Spryng délivre une demande HTTP POST pour un script sur votre serveur à chaque fois qu’un message provenant d’un mobile (MO) arrive. Vous devez définir un script qui peut traiter des données HTTP POST pour recevoir les demandes.

La demande HTTP donnée par Spryng doit recevoir une réponse HTTP par votre serveur avec un code de statut 200, ce qui signifie que le message a été accepté avec succès par votre système. Si le serveur HTTP ne peut pas être atteint, s’il répond par exemple 500 erreur interne du serveur Spryng présume que le message n’a pas été accepté avec succès par votre système et la demande sera réessayée une fois toutes les minutes. L’envoi du message ne sera pas réessayé tout le temps, elle sera effectuée pendant 24h.

Recevoir des messages provenant de Spryng

Exemple pour un script C#

using SpryngApiMoGateway.Models;

namespace SpryngApiMoGateway.Controllers
{
    public class SpryngController : Controller
    {
        [HttpGet]
        [Route("api/spryng/mo-gateway-webhook")]
        public ActionResult Index(MoGatewayResponseModel model)
        {
            // ASP.Net doesn't properly serialize the timestamp. Serialize it manually.
            model.Timestamp = DateTime.ParseExact(Request.QueryString["TIMESTAMP"], "yyyyMMddHHmmss", CultureInfo.InvariantCulture);

            return Json(model, JsonRequestBehavior.AllowGet);
        }
    }
}

Paramètres

Paramètre
MSISDN Le numéro de téléphone depuis lequel la réponse provient
KEYWORD Le mot-clé avec lequel le message commence
PARM L’ensemble du texte du message situé après le mot-clé
OPERATOR Le code de réseau du MSISDN
TIMESTAMP Temps que le message met pour être reçu par SMSC ou par le système
SHORTCODE Le shortcode auquel la réponse a été envoyée
COUNTRY Le code de pays à trois lettres (ISO 3166-1 alpha-3)

MSISDN

Le numéro de téléphone dont la réponse est originaire.

Type MSISDN-numérique (Format international sans “00” ou “+”)
Longueur Min 1 MSISDN
Longueur Max 1 MSISDN
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple MSISDN=33612345678

KEYWORD

Le mot-clé avec lequel le message commence. Les caractères seront encodés par Url.

Type Alphanumérique
Longueur Min 2
Longueur Max 15
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple KEYWORD=WIN

PARM

L’ensemble du texte du message situé après le mot-clé. Les caractères seront encodés par Url.

Type Alphanumérique
Longueur Min <na>
Longueur Max <na>
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple PARM=ON

OPERATOR

Code réseau du MSISDN. Les codes réseau des autres pays peuvent être trouvés sur le site suivant: http://www.mcc-mnc.com/.

Type Numérique
Longueur Min 5
Longueur Max 5
Valeur Min <na>
Valeur Max <na>
Valeurs See appendix B
Valeur par défaut OPERATOR=20408
Exemple MSISDN=33612345678

TIMESTAMP

Temps que le message met pour être reçu par SMSC ou s’ils n’ont pas été fournis; temps qu’il entre en contact avec notre système. Voir annexe A des types de champs.

Type Temps
Longueur Min 14
Longueur Max 14
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple TIMESTAMP=20040208152544

SHORTCODE

Le shortcode auquel la réponse a été envoyée.

Type Numérique (format national)
Longueur Min <na>
longueur Max <na>
Valeur Min <na>
Valeur Max <na>
Valeurs <na>
Valeur par défaut <none>
Exemple SHORTCODE=4414

COUNTRY

Le code de pays à trois lettres ISO 3166-1 alpha-3. Une liste des ISO 3166-1 alpha-3 codes couramment utilisé est disponible sur http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3.

Type Alphanumérique (ISO 3166-1 alpha-3)
Longueur Min 3
Longueur Max 3
Valeur Min ABW
Valeur Max ZWE
Valeurs ISO 3166-1 alpha-3
Valeur par défaut <none>
Exemple COUNTRY=NLD

Field types

Type Valeurs
Numeric caractères 0 à 9
Alphanumeric caractère de l’ISO-8859-1
MSISDN-numeric caractères 0 à 9, Le premier caractère peut être le signe ‘+’
Time temps comme YYYYMMDDHHMMSS

Network codes

Ci-dessous la liste des codes réseau couramment utilisé pour les paramètres OPERATOR.

Opérateur Code réseau
Belgique
Proximus 20601
Mobistar 20610
Base 20620
France
Bouygues Telecom 20820
Orange 20801
SFR 20810
Allemagne
T-Mobile 26201
E-Plus 26203
Mobilcom 26213
O2 26207
Vodafone 26202
Espagne
Orange 21403
Telefonica 21407
Vodafone 21401
Pays-Bas
KPN Mobile 20408
Vodafone 20404
T-Mobile 20416
Telfort 20412
Orange 20420
Tele2 20402
Turquie
Avea 28604
Vodafone 28602
Turkcell 28601
Royaume-Uni
3 23420
O2 23410
Orange 23433
T-Mobile 23430
Vodafone 23415