Obtenir l'état du rapport

Cet extrait de code vous montre comment obtenir le statut d'un état. Il est souvent utilisé pour déterminer si la génération d'un rapport s'est terminée avec succès ou non.

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).

REQUEST_ID

The request ID returned when a report was created

Rédiger le code

Ajouter ce qui suit à get-report-status.sh:

curl -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
     "https://api.nexmo.com/v2/reports/$REQUEST_ID"

Voir la source complète

Exécutez votre code

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

bash get-report-status.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
    },
    ...
  ]
}

Les file_id est également renvoyée dans la réponse, dans ce cas e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1. Les file_id est utilisé pour télécharger ultérieurement un fichier Zip de rapport.

Voir aussi