Skip to content

Lister plusieurs essais d'authentification

get
https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrials

Cette opération permet d'extraire de la plateforme Reach les enregistrements d'essais d'authentification qui répondent aux critères spécifiés.

Lors du listing des enregistrements, les résultats seront triés en fonction du champ dateCreated, le plus récent apparaissant en premier.

Paramètres

  • deststringoptional

    Liste les essais d'authentification envoyés uniquement à ce numéro de téléphone ou à cet e-mail. Le numéro de téléphone doit être au format E.164.

  • trialStatusstringoptional

    Liste les essais d'authentification avec le statut spécifié. Au choix entre successful, ou unsuccessful.

  • channelstringoptional

    Liste les essais d'authentification envoyés via le canal spécifié. Au choix entre sms, ou email.

  • configurationIdstringoptional

    Liste les essais d'authentification associés à la configuration dont l'ID correspond à celle spécifiée.

  • authenticationIdstringoptional

    Liste les essais d'authentification associés à l'authentification dont l'ID correspond à celle spécifiée.

  • countrystringoptional

    Liste les essais d'authentification envoyés au pays de destination spécifié (en format ISO 3166-1 alpha-2). Uniquement possible lorsque dest est un numéro de téléphone.

  • sentAtdate-timeoptional

    Liste les essais d'authentification générés à la date spécifiée. Doit être au format ISO 8601.

  • sentAfterdate-timeoptional

    Liste les essais d'authentification générés après la date spécifiée. Doit être au format ISO 8601.

  • sentBeforedate-timeoptional

    Liste les essais d'authentification générés avant la date spécifiée. Doit être au format ISO 8601.

  • 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 tous les essais d'authentification

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrials?pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalAuthenticationTrials": 1,
  "totalPages": 1,
  "outOfPageRange": false,
  "authenticationTrials": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "configurationId": "CIDXXXXXXXXXXXX",
      "authenticationId": "VIDXXXXXXXXXXXX",
      "trialId": "TRDXXXXXXXXXX",
      "trialStatus": "successful",
      "channel": "sms",
      "paymentInfo": {
        "payee": "ACME",
        "amount": 1000,
        "currency": "xaf"
      },
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z",
      "price": 25.0,
      "priceUnit": "xaf",
      "channelInfo": {}
    }
  ]
}

Exemple 2: Récupérer les essais d'authentification réussis envoyés au Cameroun

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrials?country=CM&trialStatus=successful&pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalAuthenticationTrials": 1,
  "totalPages": 1,
  "outOfPageRange": false,
  "authenticationTrials": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "configurationId": "CIDXXXXXXXXXXXX",
      "authenticationId": "VIDXXXXXXXXXXXX",
      "trialId": "TRDXXXXXXXXXX",
      "trialStatus": "successful",
      "channel": "sms",
      "paymentInfo": {
        "payee": "ACME",
        "amount": 1000,
        "currency": "xaf"
      },
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z",
      "price": 25.0,
      "priceUnit": "xaf",
      "channelInfo": {}
    }
  ]
}