Obtener tipos de eventos de Audit
En este fragmento de código se muestra cómo obtener una lista de todos los tipos de eventos admitidos.
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). |
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
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.
Crea un archivo llamado get-event-types.sh y añade el siguiente código:
source "../config.sh"Escriba el código
Añada lo siguiente a get-event-types.sh:
curl -X "OPTIONS" "https://api.nexmo.com/beta/audit/events" \
-u "$VONAGE_API_KEY:$VONAGE_API_SECRET"Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
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
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.
npm install @vonage/auditCrea un archivo llamado get-event-types.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,
});Escriba el código
Añada lo siguiente a get-event-types.js:
auditClient.getEvent()
.then((event) => console.log(event))
.catch((error) => console.error(error));Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Pruébalo
Ejecute el comando en un intérprete de comandos. La llamada recuperará una lista de los tipos de eventos de auditoría admitidos, similar a la siguiente:
{
"eventTypes": [
{
"type": "USER_STATUS",
"description": "User status updated"
},
{
"type": "USER_UPDATE",
"description": "User updated"
},
{
"type": "USER_BILLING_UPDATE",
"description": "User billing updated"
},
{
"type": "USER_CREATE",
"description": "User created"
},
{
"type": "USER_LOGIN",
"description": "User login into Customer dashboard"
},
{
"type": "USER_LOGOUT",
"description": "User logout from Customer dashboard"
},
{
"type": "USER_PRODUCT_SEARCH",
"description": "User product search"
},
{
"type": "USER_API_KEYS_UPDATE",
"description": "Sub-accounts for user updated"
},
{
"type": "ACCOUNT_SECRET_DELETE",
"description": "Account secret deleted"
},
{
"type": "ACCOUNT_SECRET_CREATE",
"description": "Account secret created"
},
{
"type": "ACCOUNT_UPDATE_SETTINGS_API",
"description": "Account Settings updated via API"
},
{
"type": "NUMBER_ASSIGN",
"description": "Number assigned"
},
{
"type": "NUMBER_UPDATED",
"description": "Number updated"
},
{
"type": "NUMBER_USER_CANCELED",
"description": "Number canceled by user"
},
{
"type": "NUMBER_LINKED",
"description": "Number linked to application"
},
{
"type": "NUMBER_UNLINKED",
"description": "Number unlinked from application"
},
{
"type": "APP_CREATE",
"description": "Application created"
},
{
"type": "APP_UPDATE",
"description": "Application updated"
},
{
"type": "APP_DELETE",
"description": "Application deleted"
},
{
"type": "APP_DISABLE",
"description": "Application disabled"
},
{
"type": "APP_ENABLE",
"description": "Application enabled"
},
{
"type": "IP_WHITELIST_CREATE",
"description": "Whitelist IP added"
},
{
"type": "IP_WHITELIST_DELETE",
"description": "Whitelist IP deleted"
},
{
"type": "AUTORELOAD_ENABLE",
"description": "Automatic reload enabled"
},
{
"type": "AUTORELOAD_UPDATE",
"description": "Automatic reload settings updated"
},
{
"type": "AUTORELOAD_DISABLE",
"description": "Automatic reload disabled"
}
]
}