Verificar o status do relatório

Este trecho de código mostra como obter o status de um relatório. Ele costuma ser usado para determinar se a geração de um relatório foi concluída com sucesso ou não.

Exemplo

ChaveDescrição
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

Escreva o código

Adicione o seguinte ao arquivo ` get-report-status.sh`:

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

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

bash get-report-status.sh

Pré-requisitos

Install-Package Vonage

Crie um arquivo chamado ` GetReport.cs ` e insira o seguinte código:

var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
Client = new VonageClient(credentials);

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` GetReport.cs`:

var request = GetReportRequest.Build()
    .WithReportId(requestId)
    .Create();
var response = await Client.ReportsClient.GetReportAsync(request);

Ver código-fonte completo

Experimente

  1. Defina as variáveis substituíveis. Parâmetro a validade pode variar de acordo com produto.

  2. Execute o script e você receberá uma resposta semelhante à seguinte:

{
  "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
    },
    ...
  ]
}

O file_id também é retornado na resposta; neste caso, e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1. O file_id é usado para baixar posteriormente um arquivo ZIP com o relatório.

Veja também