検証リクエストのキャンセル

ユーザーが正しいコードを入力した場合でも、Verify API にキャンセル要求を送信して検証プロセスを終了することができます。

必要に応じて、サンプルコードの以下の変数を独自の値に置き換えてください：

キー	説明
`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.

コードを書く

cancel-request.sh に以下を追加する：

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

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

sh cancel-request.sh

前提条件

npm install @vonage/server-sdk

cancel-request.js という名前のファイルを作成し、以下のコードを追加する：

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

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

全文を見る

コードを書く

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));

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

node cancel-request.js

前提条件

build.gradle に以下を追加する：

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

CancelVerificationRequest という名前のファイルを作成し、main メソッドに以下のコードを追加する：

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

全文を見る

コードを書く

CancelVerificationRequest ファイルのmain メソッドに以下を追加する：

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

全文を見る

コードを実行する

Gradle用のアプリケーション プラグインを使うことで、アプリケーションの実行を簡単にすることができます。build.gradle を以下のように更新する：

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

以下のgradle コマンドを実行し、com.vonage.quickstart.kt.verify をCancelVerificationRequest を含むパッケージに置き換えてアプリケーションを実行する：

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

前提条件

build.gradle に以下を追加する：

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

CancelRequest という名前のファイルを作成し、main メソッドに以下のコードを追加する：

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

全文を見る

コードを書く

CancelRequest ファイルのmain メソッドに以下を追加する：

client.getVerify2Client().cancelVerification(VERIFY_REQUEST_UUID);

全文を見る

コードを実行する

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

以下のgradle コマンドを実行し、com.vonage.quickstart.verify2 をCancelRequest を含むパッケージに置き換えてアプリケーションを実行する：

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

前提条件

Install-Package Vonage

CancelRequest.cs という名前のファイルを作成し、以下のコードを追加する：

using Vonage;
using Vonage.Request;

全文を見る

CancelRequest.cs に以下を追加する：

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

全文を見る

コードを書く

CancelRequest.cs に以下を追加する：

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

全文を見る

前提条件

composer require vonage/client

cancel.php という名前のファイルを作成し、以下のコードを追加する：

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

全文を見る

コードを書く

cancel.php に以下を追加する：

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

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

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

php cancel.php

前提条件

pip install vonage python-dotenv

コードを書く

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)

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

python verify/cancel-request.py

前提条件

gem install vonage

cancel.rb という名前のファイルを作成し、以下のコードを追加する：

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

全文を見る

コードを書く

cancel.rb に以下を追加する：

client.verify2.cancel_verification_request(
  request_id: VERIFY_REQUEST_ID
)

全文を見る

コードを実行する

このファイルをあなたのマシンに保存し、実行する：

ruby cancel.rb