テンプレートの更新

テンプレートを更新して、デフォルトの状態や固有の名前を変更することができます。

キー説明
VONAGE_APPLICATION_ID

The Vonage Application ID.

VONAGE_APPLICATION_PRIVATE_KEY_PATH

Private key path.

JWT

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

TEMPLATE_ID

The custom template ID

コードを書く

update-template.sh に以下を追加する:

curl -X PATCH "https://api.nexmo.com/v2/verify/templates/$VERIFY_TEMPLATE_ID" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json' \
  -d $'{
	   "name": "my-renamed-template",
     "is_default": false,
  }'

全文を見る

コードを実行する

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

sh update-template.sh

前提条件

npm install @vonage/server-sdk

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

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

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

全文を見る

コードを書く

update-template.js に以下を追加する:

vonage.verify2.getTemplateFragment(
  VERIFY_TEMPLATE_ID,
  {
    name: 'Updated template name',
    isDefault: true,
  },
)
  .then((fragment) => console.log(fragment))
  .catch((error) => console.error(error));

全文を見る

コードを実行する

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

node update-template.js

前提条件

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

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

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

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

全文を見る

コードを書く

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

val existingTemplate = client.verify.template(VERIFY_TEMPLATE_ID)
val updatedTemplate = existingTemplate.update(
    name = VERIFY_TEMPLATE_NAME, isDefault = false
)
println(updatedTemplate)

全文を見る

コードを実行する

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

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

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

gradle run -Pmain=com.vonage.quickstart.kt.verify.templates.UpdateTemplate

前提条件

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

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

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

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

全文を見る

コードを書く

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

var updated = client.getVerify2Client().updateTemplate(VERIFY_TEMPLATE_ID, VERIFY_TEMPLATE_NAME, false);
System.out.println(updated);

全文を見る

コードを実行する

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

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

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

gradle run -Pmain=com.vonage.quickstart.verify2.templates.UpdateTemplate

前提条件

Install-Package Vonage

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

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

全文を見る

コードを書く

UpdateTemplateRequest.cs に以下を追加する:

var request = Vonage.VerifyV2.UpdateTemplate.UpdateTemplateRequest.Build()
    .WithId(TEMPLATE_ID)
    .WithName("my-renamed-template")
    .SetAsNonDefaultTemplate()
    .Create();
var response = await client.VerifyV2Client.UpdateTemplateAsync(request);

全文を見る

前提条件

composer require vonage/client

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

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

全文を見る

コードを書く

update-template.php に以下を追加する:

$updateRequest = new UpdateCustomTemplateRequest('my-renamed-template', true);

$client->verify2()->updateCustomTemplate(TEMPLATE_ID, $updateRequest);

全文を見る

コードを実行する

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

php update-template.php

前提条件

gem install vonage

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

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

全文を見る

コードを書く

update-template.rb に以下を追加する:

template = client.verify2.templates.update(
  template_id: VERIFY_TEMPLATE_ID,
  name: 'my-renamed-template',
  is_default: false
)

全文を見る

コードを実行する

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

ruby update-template.rb