Liste des sous-comptes

Cette requête est utilisée pour lister les sous-comptes de votre compte principal.

URL

GET https://api.smspartner.fr/v1/subaccount/list

Paramètres obligatoires

Nom
Valeur

page

Le numéro de la page, il y a 20 résultats par page. Si ce paramètre est laissé vide la page 1 sera retourné.

Paramètre optionnel

Nom
Valeur

_format

json ou xml

Requêtes

<?php
 
        // Prepare data for GET request
        $data = 'apiKey=YOUR_API_KEY';
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/subaccount/list?'.$data);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
 
 
        $result = curl_exec($curl);
        curl_close($curl);
 
        // Process your response here
        echo $result;
?>

Réponse

{
  "success": true,
  "code": 200,
  "total": 29,
  "nb_per_page": 20,
  "page": 1,
  "data": [
    {
      "id": 1,
      "email": "email1",
      "type": "simple",
      "token": "token1", //Est utilisé comme identifiant du sous-compte pour ajouter des crédits
      "apiKey": "ApiKey sous compte",
      "createdAt": "2016-03-04 11:23:14",
      "credits": {
          "balance": "0.800",
          "currency": "EUR"
      }
    },
    {
      "id": 2,
      "email": "email2",
      "type": "simple",
      "token": "token2",
      "apiKey": "ApiKey2 du sous compte",
      "createdAt": "2016-03-04 11:23:14",
      "credits": {
          "balance": "10.245",
          "currency": "EUR"
      }
    }
  ]
}

Erreurs

{
  "success": false,
  "code": 10,
  "message": "Clé API incorrecte"
}

Code erreurs

Code de réponse
Réponse

1

La Clé API est requise

10

Clé API incorrecte

200

Tout s'est bien passé !

Dernière mise à jour