Skip to content

Lister plusieurs Authentifications

get
https://api.reach.talkylabs.com/rest/authentix/v1/configurations/{configurationId}/authentications

Cette opération permet de récupérer toutes les authentifications générées à partir d'une configuration donnée qui ne sont pas expirées et pour lesquelles le nombre d'essais/contrôles maximum n'est pas dépassé.

Lors de l'obtention de la liste des authentifications, les résultats seront triés en fonction du champ dateCreated, le plus récent apparaissant en premier.

Paramètres

  • configurationIdstringrequiredpath

    L'identifiant de la configuration utilisée.

  • pageSizeintegeroptional

    Nombre maximum d'objets à retourner à chaque invocation de la requête. La valeur par défaut est 20.

  • pageintegeroptional

    Il s'agit de la page d'objets à retourner. Cela permet d'éviter de renvoyer des données en double. La valeur par défaut est 0.

Exemple 1: Lister les authentifications en cours

L'exemple ci-dessous montre comment lister de la plateforme Reach les authentifications précédemment initiées qui sont encore en attente.

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications?pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalAuthentications": 1,
  "totalPages": 1,
  "outOfPageRange": false,
  "authentications": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "configurationId": "CIDXXXXXXXXXXXX",
      "authenticationId": "VIDXXXXXXXXXXXX",
      "status": "awaiting",
      "dest": "+237671234567",
      "channel": "sms",
      "expiryTime": 5,
      "maxTrials": 5,
      "maxControls": 3,
      "paymentInfo": {
        "payee": "ACME",
        "amount": 1000,
        "currency": "xaf"
      },
      "trials": [
        {
          "dateCreated": "2016-08-29T09:12:33.001Z",
          "trialId": "TRDXXXXXXXXXX",
          "channel": "sms"
        }
      ],
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z"
    }
  ]
}