Annuler une demande de vérification

Vous pouvez envoyer une demande d'annulation à l'API Verify pour mettre fin au processus de vérification, même si l'utilisateur a fourni le bon code.

Le cas échéant, remplacez les variables suivantes dans l'exemple de code par vos propres valeurs :

CléDescription
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.

Rédiger le code

Ajouter ce qui suit à cancel-request.sh:

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

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

sh cancel-request.sh

Conditions préalables

npm install @vonage/server-sdk

Créez un fichier nommé cancel-request.js et ajoutez le code suivant :

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

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à 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));

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

node cancel-request.js

Conditions préalables

Ajouter ce qui suit à build.gradle:

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

Créez un fichier nommé CancelVerificationRequest et ajoutez le code suivant à la méthode main:

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à la méthode main du fichier CancelVerificationRequest:

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

Voir la source complète

Exécutez votre code

Nous pouvons utiliser le plugin application pour Gradle afin de simplifier l'exécution de notre application. Mettez à jour votre build.gradle avec ce qui suit :

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

Lancez la commande suivante gradle pour exécuter votre application, en remplaçant com.vonage.quickstart.kt.verify par le paquet contenant CancelVerificationRequest:

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

Conditions préalables

Ajouter ce qui suit à build.gradle:

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

Créez un fichier nommé CancelRequest et ajoutez le code suivant à la méthode main:

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à la méthode main du fichier CancelRequest:

client.getVerify2Client().cancelVerification(VERIFY_REQUEST_UUID);

Voir la source complète

Exécutez votre code

Nous pouvons utiliser le plugin application pour Gradle afin de simplifier l'exécution de notre application. Mettez à jour votre build.gradle avec ce qui suit :

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

Lancez la commande suivante gradle pour exécuter votre application, en remplaçant com.vonage.quickstart.verify2 par le paquet contenant CancelRequest:

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

Conditions préalables

Install-Package Vonage

Créez un fichier nommé CancelRequest.cs et ajoutez le code suivant :

using Vonage;
using Vonage.Request;

Voir la source complète

Ajouter ce qui suit à CancelRequest.cs:

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à CancelRequest.cs:

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

Voir la source complète

Conditions préalables

composer require vonage/client

Créez un fichier nommé cancel.php et ajoutez le code suivant :

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à cancel.php:

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

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

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

php cancel.php

Conditions préalables

pip install vonage python-dotenv

Rédiger le code

Ajouter ce qui suit à 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)

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

python verify/cancel-request.py

Conditions préalables

gem install vonage

Créez un fichier nommé cancel.rb et ajoutez le code suivant :

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à cancel.rb:

client.verify2.cancel_verification_request(
  request_id: VERIFY_REQUEST_ID
)

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

ruby cancel.rb