Cancelar uma solicitação de verificação

Você pode enviar uma solicitação de cancelamento à API do Verify para encerrar o processo de verificação, mesmo que o usuário tenha fornecido o código correto.

Quando necessário, substitua as seguintes variáveis no código de exemplo pelos seus próprios valores:

ChaveDescrição
JWT

Used to authenticate your request. See Authentication for more information, including how to generate a JWT.

REQUEST_ID

The ID of the Verify request (this is returned in the API response when you send a verification code)

VONAGE_APPLICATION_PRIVATE_KEY_PATH

Private key path.

VONAGE_APPLICATION_ID

The Vonage Application ID.

Escreva o código

Adicione o seguinte ao arquivo ` cancel-request.sh`:

curl -X DELETE "https://api.nexmo.com/v2/verify/$VERIFY_REQUEST_ID" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json'

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

sh cancel-request.sh

Pré-requisitos

npm install @vonage/server-sdk

Crie um arquivo chamado ` cancel-request.js ` e insira o seguinte código:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage ({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` cancel-request.js`:

vonage.verify2.cancel(VERIFY_REQUEST_ID)
  .then((status) => status
    ? console.log('Request cancelled')
    : console.log('Request was already fullfilled or request id is invalid'),
  )
  .catch((error) => console.error(error));

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

node cancel-request.js

Pré-requisitos

Adicione o seguinte ao arquivo ` build.gradle`:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Crie um arquivo chamado ` CancelVerificationRequest ` e adicione o código a seguir ao método ` main `:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao método ` main ` do arquivo ` CancelVerificationRequest `:

client.verify.request(VERIFY_REQUEST_ID).cancel()

Ver código-fonte completo

Execute seu código

Podemos usar o plugin “ aplicativo ” para o Gradle a fim de simplificar a execução do nosso aplicativo. Atualize seu arquivo ` build.gradle ` com o seguinte:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Execute o seguinte comando ` gradle ` para rodar seu aplicativo, substituindo ` com.vonage.quickstart.kt.verify ` pelo pacote que contém ` CancelVerificationRequest`:

gradle run -Pmain=com.vonage.quickstart.kt.verify.CancelVerificationRequest

Pré-requisitos

Adicione o seguinte ao arquivo ` build.gradle`:

implementation 'com.vonage:server-sdk:9.3.1'

Crie um arquivo chamado ` CancelRequest ` e adicione o código a seguir ao método ` main `:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao método ` main ` do arquivo ` CancelRequest `:

client.getVerify2Client().cancelVerification(VERIFY_REQUEST_UUID);

Ver código-fonte completo

Execute seu código

Podemos usar o plugin “ aplicativo ” para o Gradle a fim de simplificar a execução do nosso aplicativo. Atualize seu arquivo ` build.gradle ` com o seguinte:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Execute o seguinte comando ` gradle ` para rodar seu aplicativo, substituindo ` com.vonage.quickstart.verify2 ` pelo pacote que contém ` CancelRequest`:

gradle run -Pmain=com.vonage.quickstart.verify2.CancelRequest

Pré-requisitos

Install-Package Vonage

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

using Vonage;
using Vonage.Request;

Ver código-fonte completo

Adicione o seguinte ao arquivo ` CancelRequest.cs`:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_APPLICATION_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` CancelRequest.cs`:

var request = Vonage.VerifyV2.Cancel.CancelRequest.Parse(REQUEST_ID);
var response = await client.VerifyV2Client.CancelAsync(request);

Ver código-fonte completo

Pré-requisitos

composer require vonage/client

Crie um arquivo chamado ` cancel.php ` e insira o seguinte código:

$client = new Vonage\Client(
    new Vonage\Client\Credentials\Keypair(VONAGE_APPLICATION_PRIVATE_KEY_PATH, VONAGE_APPLICATION_ID),
);

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` cancel.php`:

$newRequest = new \Vonage\Verify2\Request\SMSRequest(VERIFY_NUMBER, VERIFY_BRAND_NAME);

$client->verify2()->cancelRequest(REQUEST_ID);

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

php cancel.php

Pré-requisitos

pip install vonage python-dotenv

Escreva o código

Adicione o seguinte ao arquivo ` cancel-request.py`:

from vonage import Auth, Vonage

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

client.verify.cancel_verification(request_id=VERIFY_REQUEST_ID)

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

python verify/cancel-request.py

Pré-requisitos

gem install vonage

Crie um arquivo chamado ` cancel.rb ` e insira o seguinte código:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` cancel.rb`:

client.verify2.cancel_verification_request(
  request_id: VERIFY_REQUEST_ID
)

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

ruby cancel.rb