Rapports de liste

Cette opération est obsolète. Veuillez utiliser la fonction "Obtenir des enregistrements de manière synchrone par plage de dates" et d'utiliser l'élément REPORTS-USAGE produit. Vous pouvez également utiliser le "Créer un rapport de manière asynchrone" à l'aide de l'élément REPORTS-USAGE dans la charge utile.

Cet extrait de code vous montre comment dresser la liste de toutes les demandes de rapports asynchrones avec le statut spécifié. Si nécessaire, vous pouvez également spécifier une plage de dates.

Il convient de noter que la période de conservation des données est de 4 jours. Les rapports datant de plus de 4 jours ne seront donc pas répertoriés.

Exemple

CléDescription
VONAGE_API_KEY

Your Vonage API key (see it on your dashboard).

VONAGE_API_SECRET

Your Vonage API secret (also available on your dashboard).

ACCOUNT_ID

The account ID (same as VONAGE_API_KEY) for the account you want to generate reports, or retrieve records for.

REPORT_STATUS

Status of report generation, can be any of PENDING, PROCESSING, SUCCESS, ABORTED, FAILED, TRUNCATED. For report listing, status is passed in as a comma-separated list of report status values.

Si vous ne spécifiez pas de plage de dates, vous recevez les rapports générés au cours des sept jours précédents.

Rédiger le code

Ajouter ce qui suit à list-reports.sh:

curl -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
     "https://api.nexmo.com/v2/reports?account_id=$ACCOUNT_ID&status=$REPORT_STATUS"

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

bash list-reports.sh

Essayez-le

  1. Définir les variables remplaçables. Paramètres La validité peut varier en fonction de l'âge de l'enfant. produit.

  2. Exécutez le script et vous obtiendrez une réponse similaire à la suivante :

{
  "self_link": "https://api.nexmo.com/v2/reports?account_id=abcd1234&status=SUCCESS",
  "items_count": 17,
  "reports": [
    {
      "request_id": "ri3p58f-48598ea7-1234-5678-90ab-faabd79abcde",
      "request_status": "SUCCESS",
      "direction": "outbound",
      "product": "SMS",
      "account_id": "abcd1234",
      "date_start": "2020-05-21T13:27:00+0000",
      "date_end": "2020-05-21T13:57:00+0000",
      "include_subaccounts": false,
      "status": "delivered",
      "include_message": false,
      "receive_time": "2020-06-03T15:24:31+0000",
      "start_time": "2020-06-03T15:24:32+0000",
      "_links": {
        "self": {
          "href": "https://api.nexmo.com/v2/reports/ri3p58f-48598ea7-1234-5678-90ab-faabd79abcde"
        },
        "download_report": {
          "href": "https://api.nexmo.com/v3/media/e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1"
        }
      },
      "items_count": 4
    },
    ...
  ]
}

Noter le rapport request_id se trouve dans la réponse. De même, les file_idDans ce cas e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1.

Voir aussi