Envoyer un SMS

1- Envoi d’un SMS via l’API FasterMessage #

Pour envoyer un SMS, vous devez lancer une requête HTTP POST vers le point de terminaison spécifique de l’API.

• URL du point de terminaison : https://api.fastermessage.com/v1/sms/send
• Résultat : L’API retourne une réponse indiquant l’état de la requête (confirmation de succès ou code d’erreur en cas d’échec).

Les Paramètres de la Requête d’Envoi #

Les paramètres sont les données que vous devez transmettre à l’API pour définir le message à envoyer.

2- Gestion des Caractères du Champ text #

• SMS Standard : Contient généralement 160 caractères (sans aucun accent/caractère spécial).
• SMS Non Standard : Contient 153 caractères lorsqu’il y a des accents ou des caractères spéciaux.
• Messages Multipart (Longs) : Chaque page supplémentaire est limitée à 70 caractères sans accents ou 63 caractères avec accents.
• Recommandation : Il est conseillé de ne pas dépasser 3 pages SMS pour garantir une bonne délivrabilité et éviter un coût excessif.

Remarques Importantes sur la Sécurité et la Qualité #

• Paramètres Obligatoires vs. Optionnels :
  • Les paramètres affichés avec un badge rouge sont obligatoires.
  • Les paramètres affichés avec un badge vert sont optionnels.
• Sécurité HTTPS : Toutes les requêtes d’authentification (Basic ou Clé API) doivent transiter via HTTPS pour garantir la confidentialité des informations (chiffrement).
• Gestion des Caractères par les Opérateurs : Les opérateurs peuvent appliquer des règles de segmentation ou de translitérations. Certains caractères accentués peuvent être modifiés ou rejetés selon les réseaux locaux.

Exemple de code d’intégration #

<?php
    $key        = base64_encode("Mon_Username:Mon_Password");
    $url        = "https://api.fastermessage.com/v1/sms/send";
    $params         = array(
        "from"  => "FASTERMSG",
        "to"    => "2292731",
        "text"  => "Hello world!"
    );

    $curl = curl_init($url);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER,1);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array("Authorization: Basic ".$key));
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $params);

    $result = curl_exec($curl);
    $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    curl_close($curl);

    printf($result);
    printf($status);
?>

curl -X POST https://api.fastermessage.com/v1/sms/send -H 'Content-Type: application/json' -H 'Authorization: Basic Username_et_Paswword_encoder_en_base_64' -d '{"from":"FASTERMSG","to":"2292731","text":"Hello world!"}'

import requests

url = 'https://api.fastermessage.com/v1/sms/send'

params = {from='FASTERMSG',to='2292731',text='Hello world!'}

headers = {'Authorization': 'Basic Username_et_Paswword_encoder_en_base_64'}

req = requests.post(url, data=params, headers=headers)

print(req.status_code)
print(req.headers)
print(req.text)

const http = require('https');

var postData = JSON.stringify({
    'from' : 'FASTERMSG',
    'to'   : '2292731',
    'text' : 'Hello world!'
});

const init = {
    hostname: 'https://api.fastermessage.com/v1/sms/send',
    path: '/',
    method: 'POST',
    headers: {
        'Authorization': 'Basic Username_et_Paswword_encoder_en_base_64',
        'Content-Type': 'application/json',
        'Content-Length': postData.length
    }
};

const request = http.request(init, (resp)=>{
    let result = Buffer.alloc(0);
    resp.on('data', function(chunk) {
        result = Buffer.concat([result, chunk]);
    });
    resp.on('end', function() {
        // result has response body buffer
        console.log(result.toString());
    });
});

request.write(postData);
request.end();

Réponse après envoi #

Après l’envoi d’un SMS via l’API FASTERMESSAGE, vous obtiendrez en retour une réponse du serveur au format JSON comme ci-après.

{
    "status": true,
    "code": "SUBMITTED",
    "description": "202: The request has been submitted and is being processed",
    "from": "FASTERMSG",
    "to": "2292731",
    "text": "Hello world!",
    "smsCount": 1,
    "messageId": "1698143748226271",
    "uuid": "691bb97c4d36231cfea54312",
    "sendAt": "2023-10-24T10:35:48.226+01:00",
    "createdAt": "2023-10-24T10:35:48.286+01:00",
    "message": "The request is processing",
    "reference": "",
    "batchId": "",
    "priority": 3,
    "iso": "BJ",
    "country": "Benin",
    "cc": 229,
    "operator": "MTN",
    "mcc": "616",
    "mnc": "03"
}

// Un exemple de réponse lorsqu'une erreur est détectée lors de la vérification des variables reçu.
{
    "status": false,
    "code": "AUTHENTICATION_FAILED",
    "description": "401: Authentication failed"
}

// Un exemple de réponse lorsqu'une erreur est détectée lors de l'envoi du message.
{
    "status": false,
    "code": "INVALID_PHONE",
    "description": "400: Invalid phone number",
    "messageId": "1698148205253794"
}

Passons en revue les informations renvoyées par le serveur à la suite de la requête d’envoi :

• status : c’est l’état de soumission de la requête. Il est TRUE si tout s’est bien passé ou FALSE s’il y a un problème ;
• code : il s’agit du code retourné par la requête. Voir la liste des codes pour plus de détails
• description : c’est le message descriptif du code;