Obter tipos de eventos de Audit
Neste trecho de código, você vê como obter uma lista de todos os tipos de eventos suportados.
Exemplo
Você precisará garantir que os seguintes valores substituíveis sejam definidos no código de exemplo, utilizando qualquer método que lhe seja conveniente:
| Chave | Descrição |
|---|---|
VONAGE_API_KEY | Your Vonage API key (see it on |
VONAGE_API_SECRET | Your Vonage API secret (also available on |
No exemplo a seguir, o Criar um aplicativo e Inicialize suas dependências Os procedimentos são opcionais.
Pré-requisitos
Um aplicativo da Vonage contém a configuração necessária para o seu projeto. Você pode criar um aplicativo usando o CLI da Vonage (veja abaixo) ou pelo painel de controle. Para saber mais sobre os aplicativos, acesse consulte nosso guia de conceitos da Vonage.
Instale a CLI
Criar um aplicativo
Depois de instalar a CLI, você poderá usá-la para criar um aplicativo Vonage. Execute o comando a seguir e anote o ID do aplicativo que for retornado. Esse é o valor que deve ser usado em NEXMO_APPLICATION_ID no exemplo abaixo. Isso também criará o arquivo private.key no diretório atual, que você precisará na etapa Inicialize suas dependências
O Vonage precisa se conectar ao seu computador local para acessar o answer_url. Recomendamos usar o ngrok para fazer isso. Certifique-se de substituir demo.ngrok.io nos exemplos abaixo pelo seu próprio URL do ngrok.
Crie um arquivo chamado ` get-event-types.sh ` e insira o seguinte código:
source "../config.sh"Escreva o código
Adicione o seguinte ao arquivo ` get-event-types.sh`:
curl -X "OPTIONS" "https://api.nexmo.com/beta/audit/events" \
-u "$VONAGE_API_KEY:$VONAGE_API_SECRET"Execute seu código
Salve este arquivo no seu computador e execute-o:
Pré-requisitos
Um aplicativo da Vonage contém a configuração necessária para o seu projeto. Você pode criar um aplicativo usando o CLI da Vonage (veja abaixo) ou pelo painel de controle. Para saber mais sobre os aplicativos, acesse consulte nosso guia de conceitos da Vonage.
Instale a CLI
Criar um aplicativo
Depois de instalar a CLI, você poderá usá-la para criar um aplicativo Vonage. Execute o comando a seguir e anote o ID do aplicativo que for retornado. Esse é o valor que deve ser usado em NEXMO_APPLICATION_ID no exemplo abaixo. Isso também criará o arquivo private.key no diretório atual, que você precisará na etapa Inicialize suas dependências
O Vonage precisa se conectar ao seu computador local para acessar o answer_url. Recomendamos usar o ngrok para fazer isso. Certifique-se de substituir demo.ngrok.io nos exemplos abaixo pelo seu próprio URL do ngrok.
npm install @vonage/auditCrie um arquivo chamado ` get-event-types.js ` e insira o seguinte código:
const { Audit } = require('@vonage/audit');
const auditClient = new Audit({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET,
});Escreva o código
Adicione o seguinte ao arquivo ` get-event-types.js`:
auditClient.getEvent()
.then((event) => console.log(event))
.catch((error) => console.error(error));Execute seu código
Salve este arquivo no seu computador e execute-o:
Experimente
Execute o comando em um shell. A chamada irá recuperar uma lista dos tipos de eventos de Audit suportados, semelhante à seguinte:
{
"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"
}
]
}