Push API

La Push API vous permet d’envoyer des SMS de notification automatiquement, directement depuis votre système informatique.

Quel que soit votre langage de programmation, notre API au standard REST est facilement intégrable à votre système.

Pour envoyer un SMS Push, il suffit de faire une requête HTTP de type POST avec les paramètres suivants :

• telephone : le numéro de téléphone du destinataire (format +33, 0033 ou 06/07),
• text : le texte du message (les SMS ne peuvent contenir des caractères en dehors de la table GSM),
• senderName : permet de définir le nom de l’expéditeur (commence par une lettre, ne contient pas de caractères spéciaux et ne peut faire plus de 11 caractères) [optionnel],
• Le Bearer Token récupéré depuis votre compte afin de vous identifier.

L’API retourne un JSON avec l’id du SMS envoyé, ex { id: 76543 }. Par ailleurs, notre API peut notifier une url interne de votre système lors du changement d’état du SMS. Il suffit pour cela de paramétrer cette url dans votre compte.

Cette notification s’effectue au travers d’une requête HTTP POST en JSON, contenant les paramètres suivant :
• smsId, retourné par l’API lors de la soumission,
• status, le statut du SMS (0 = en attente / 1 = reçu / 2 = NPAI / 3 = erreur).

Exemples

• CURL
• PHP
• Node.js

curl https://api.my-sms.pro/push/ \
-H 'Authorization: Bearer VOTRE_TOKEN' \
-H 'Content-Type: application/json' -X POST \
-d '{"telephone":"0600000000", "text": "Hello world", "senderName": "Renault"}'

$url = 'https://api.my-sms.pro/push/';
$ch = curl_init($url);
$payload = json_encode(array(
  'telephone' => '0600000000',
  'senderName' => 'Renault',
  'text' => 'Hello world'
));

curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Content-Type:application/json',
  'Authorization: Bearer VOTRE_TOKEN'
));

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);

var_dump($result);

const https = require('https');

const options = {
    "method": "POST",
    "hostname": "api.my-sms.pro",
    "path": "/push/",
    "headers": {
        "Content-Type": "application/json",
        "Authorization": "Bearer VOTRE_TOKEN"
    }
};

const req = https.request(options, (res) => {
    const chunks = [];

    res.on('data', (chunk) => {
        chunks.push(chunk);
    });

    res.on('end', () => {
        const body = Buffer.concat(chunks);
        console.log(body.toString());
    });

});

req.write(JSON.stringify({
    telephone: '0600000000',
    sender: 'Renault',
    text: 'Hello wolrd'
}));

req.end();