logo

I. Premiers pas

  • Inscription : rendez vous sur https://queensms.net/register et couvrez un compte.
  • Génération de clés d'API : Une fois inscrit, accédez à l'onglet API QUEEN SMS et cliquez sur Générer la clé d'API.

II. Endpoints et Ressources

II.1 Opération d’envoi de SMS

II.1.1 Requête

Paramètres de Requête :

  • api_key (string, obligatoire) : La clé d'accès générée depuis votre compte Queen SMS.
  • senderid (string, obligatoire) : Le nom de l'expéditeur (maximum 11 caractères).
  • sms (string, obligatoire) : Le contenu de votre message (facturé à 160 caractères par message).
  • mobiles (string, obligatoire) : Numéros de téléphone des destinataires, séparés par des virgules. Le préfixe "237" est facultatif. Exemple : 237XXXXXXXXX,XXXXXXXXX

Exemple de Requête POST en PHP :

        
        
<?php                                     
    $url = 'https://api.queensms.net/v1/sms.php';

    $sms_body = array(
        'api_key' => 'nUfn8PcmALbV1L1jSewE...',
        'senderid' => 'QUEEN ESSAI',
        'sms' => 'message',
        'mobiles' => '237XXXXXXXXX,XXXXXXXXX'
    );

    $options = array(
        'http' => array(
            'method' => 'POST',
            'header' => 'Content-type: application/x-www-form-urlencoded',
            'content' => http_build_query($sms_body)
        )
    );

    $context = stream_context_create($options);
    $response = file_get_contents($url, true, $context);

    if ($response === false) {
        echo "Erreur lors de la requête HTTP.";
    } else {
        echo $response;
    }
?>
    

Exemple de Requête GET en PHP :

    

    
<?php  
    $url = 'https://api.queensms.net/v1/sms.php';
    $url .= '?api_key=nUfn8PcmALbV1L1jSewE&senderid=SENDER&sms=message&mobiles=XXXXXXXXX,XXXXXXXXX,XXXXXXXXX';

    $response = file_get_contents($url);
?>

    

II.1.2 Réponse

Paramètres de Réponse :

  • responsecode (Integer) : 1 si succès, 0 si erreur.
  • responsedescription (string) : "success" en cas de succès, "error" en cas d'erreur.
  • responsemessage (string) : Le nom de l'expéditeur.
  • statut (string) : "success" en cas de succès, "error" en cas d'erreur.
  • messageid (string) : L'identifiant du message.
  • smsclientid (string) : L'identifiant de la requête.
  • errorcode (string) : Code de l'erreur (le cas échéant).
  • errordescription (Integer) : Description du code (le cas échéant).
  • mobileno (string) : Votre numéro de téléphone.

Exemple de Réponse JSON en PHP :

        
        
{
    "responsecode": 1,
    "responsedescription": "success",
    "responsemessage": "success",
    "sms": [
        {
            "messageid": "c2b849db106f0c2e07dd9b881e6bdfe7",
            "smsclientid": "0c851d9f-6c63-49fb-af16-6886c37a81de",
            "mobileno": "+237691728942",
            "statut": "success",
            "errorcode": "",
            "errordescription": ""
        },
        {
            "messageid": "e12dd358cff3961752f8c1180cc209ff",
            "smsclientid": "1cc6c9d3-a82b-4ece-85ae-aff58918488c",
            "mobileno": "+23751084334",
            "statut": "success",
            "errorcode": "",
            "errordescription": ""
        }
    ],
    "balance": "1017"
}

        
    

II.2 Vérification du solde de SMS

II.2.1 Requête

Paramètres de Requête :

  • api_key (string, obligatoire) : La clé d'accès générée depuis votre compte Queen SMS.

Exemple de Requête POST en PHP :

        

        
<?php                                     
    $url = 'https://api.queensms.net/v1/smscredit.php';

    $sms_body = array(
        'api_key' => 'nUfn8PcmALbV1L1jSewE...',
    );

    $options = array(
        'http' => array(
            'method' => 'POST',
            'header' => 'Content-type: application/x-www-form-urlencoded',
            'content' => http_build_query($sms_body)
        )
    );

    $context = stream_context_create($options);
    $response = file_get_contents($url, true, $context);

    if ($response === false) {
        echo "Erreur lors de la requête HTTP.";
    } else {
        echo $response;
    }
?>
    

Exemple de Requête GET en PHP :

    

    
<?php  
    $url = "https://api.queensms.net/v1/smscredit.php?api_key=nUfn8PcmALbV1L1jSewE";

    $response = file_get_contents($url);
?>

    

II.2.2 Réponse

Paramètres de Réponse :

  • responsecode (Integer) : 1 si succès, 0 en cas d'erreur.
  • subscriptiondate (string, obligatoire) : Date de souscription.
  • packname (string, obligatoire) : Nom du pack.
  • responsemessage (string, obligatoire) : Description de la requête.
  • credit (string, obligatoire) : Solde de votre compte.

Exemple de Réponse JSON en PHP :

        

        
{
    "responsecode": 1,
    "subscriptiondate": "2022-04-11",
    "packname": "Pack Bonus",
    "responsemessage": "success",
    "credit": "1017"
}


        
    

IV. Gestion des Erreurs

Exemple de Codes d'Erreur (*) :

  • -100019 : Utilisateur Inactif
  • -10003 : Numéro de téléphone invalide

Exemple de Messages d'Erreur () :**

  • Password require
  • User name require
  • Sender ID require
  • Mobiles required
  • Message require
  • Invalide user name or password
  • Your balance is insufficient