Obtener eventos de Audit con filtrado

En este fragmento de código se muestra cómo obtener una lista de eventos de Audit con filtrado.

Parámetros

Puede filtrar la lista de objetos de evento devueltos utilizando parámetros de consulta. Los parámetros que se pueden especificar se muestran en la siguiente tabla:

Parámetro de consulta	Descripción
`event_type`	El tipo de evento de Audit, por ejemplo: `APP_CREATE`, `NUMBER_ASSIGN`etc. Puede especificar una lista delimitada por comas de tipos de eventos aquí.
`search_text`	Cadena de búsqueda compatible con JSON. Busque un texto específico en un evento de Audit.
`date_from`	Recuperar eventos de Audit a partir de esta fecha (en formato ISO-8601).
`date_to`	Recuperar eventos de Audit hasta esta fecha (en formato ISO-8601).
`page`	Número de página a partir de la página 1.
`size`	Número de elementos por página (entre 1 y 100, por defecto 30).

Ejemplo

Tendrá que asegurarse de que los siguientes valores reemplazables se establecen en el código de ejemplo utilizando cualquier método conveniente:

Clave	Descripción
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`SEARCH_TEXT`	Some JSON compatible text to search for. For example, "number".
`DATE_FROM`	Audit events starting from this ISO-8601 datetime value. For example, "2018-07-01".
`DATE_TO`	Audit events up to this ISO-8601 datetime value. For example, "2018-08-01".

En el siguiente ejemplo, el Crear una aplicación y Inicialice sus dependencias son opcionales.

Requisitos previos

Una aplicación de Vonage contiene la configuración necesaria para tu proyecto. Puedes crear una aplicación usando CLI de Vonage (ver a continuación) o a través del cuadro de mandos. Para obtener más información sobre las aplicaciones consulta nuestra guía de Concepts de Vonage.

Instalar la CLI

npm install -g nexmo-cli

Crear una aplicación

Una vez que tengas la CLI instalada, puedes usarla para crear una aplicación de Vonage. Ejecuta el siguiente comando y anota el ID de aplicación que devuelve. Este es el valor a usar en NEXMO_APPLICATION_ID en el ejemplo de abajo. También creará private.key en el directorio actual, que necesitarás en el paso Inicialice sus dependencias.

Vonage necesita conectarse a tu máquina local para acceder a tu answer_url. Recomendamos usar ngrok para hacerlo. Asegúrate de cambiar demo.ngrok.io en los ejemplos a continuación por tu propia URL ngrok.

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Crea un archivo llamado get-events-with-filtering.sh y añade el siguiente código:

source "../config.sh"

Ver fuente completa

Escriba el código

Añada lo siguiente a get-events-with-filtering.sh:

curl "https://api.nexmo.com/beta/audit/events?search_text=$SEARCH_TEXT&date_from=$DATE_FROM&date_to=$DATE_TO" \
     -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

./get-events-with-filtering.sh

Requisitos previos

Instalar la CLI

npm install -g nexmo-cli

Crear una aplicación

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

npm install @vonage/audit

Crea un archivo llamado get-events-with-filtering.js y añade el siguiente código:

const { Audit } = require('@vonage/audit');

const auditClient = new Audit({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

Ver fuente completa

Escriba el código

Añada lo siguiente a get-events-with-filtering.js:

const run = async () => {
  const filter = {
    dateFrom: DATE_FROM,
    dateTo: DATE_TO,
    searchText: SEARCH_TEXT,
  };

  try {
    for await (const event of auditClient.getEvents(filter)) {
      console.log(event);
    }
  } catch (error) {
    console.log(error);
  }
};
run();

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

node get-events-with-filtering.js

Pruébalo

Ejecute el comando en un intérprete de comandos. La llamada recuperará una lista filtrada de eventos de auditoría.