Relatórios de lista

Essa operação está obsoleta. Por favor, use a "Obter registros de forma síncrona por intervalo de datas" trecho e use o REPORTS-USAGE produto. Você também pode usar o "Criar relatório de forma assíncrona" trecho com o REPORTS-USAGE produto na carga útil.

Este trecho de código mostra como listar todas as solicitações assíncronas de relatórios com o status especificado. Se necessário, você também pode especificar um intervalo de datas.

Observe que há um período de retenção de dados de 4 dias; portanto, relatórios com mais de 4 dias não serão exibidos.

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

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.

Se você não especificar um intervalo de datas, receberá os relatórios gerados nos últimos sete dias.

Escreva o código

Adicione o seguinte ao arquivo ` list-reports.sh`:

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

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

bash list-reports.sh

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

Anote o relatório request_id está na resposta. Além disso, o file_id, neste caso e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1.

Veja também