テンプレート・フラグメントの作成

テンプレート・フラグメントはテンプレートのコンテンツで、チャンネルとロケールによって一意に識別されます。フラグメントを作成するにはフラグメントを作成するには、すでにテンプレートを作成している必要があります。

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

コードを書く

create-template-fragment.sh に以下を追加する：

curl -X POST "https://api.nexmo.com/v2/verify/templates/$VERIFY_TEMPLATE_ID/template_fragments" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json' \
  -d $'{
	  "channel": "sms",
    "locale": "en-us",
    "text": "The authentication code for your ${brand} is: ${code}"
  }'

全文を見る

コードを実行する

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

sh create-template-fragment.sh

前提条件

npm install @vonage/server-sdk

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

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

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

全文を見る

コードを書く

create-template-fragment.js に以下を追加する：

vonage.verify2.createTemplateFragment(
  VERIFY_TEMPLATE_ID,
  {
    channel: 'sms',
    locale: 'en-us',
    text: 'The authentication code for your ${brand} is: ${code}',
  },
)
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

全文を見る

コードを実行する

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

node create-template-fragment.js

前提条件

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

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

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

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

全文を見る

コードを書く

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

val existingTemplate = client.verify.template(VERIFY_TEMPLATE_ID)
val fragment = existingTemplate.createFragment(
    text = "The authentication code for your \${brand} is: \${code}",
    channel = FragmentChannel.SMS,
    locale = "en-us"
)
println(fragment.fragmentId)

全文を見る

コードを実行する

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

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

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

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

前提条件

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

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

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

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

全文を見る

コードを書く

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

var fragment = client.getVerify2Client().createTemplateFragment(
		VERIFY_TEMPLATE_ID, new TemplateFragment(
				FragmentChannel.SMS, "en-us",
				"The authentication code for your ${brand} is: ${code}"
		)
);
System.out.println(fragment);

全文を見る

コードを実行する

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

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

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

前提条件

Install-Package Vonage

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

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

全文を見る

コードを書く

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

var request = Vonage.VerifyV2.CreateTemplateFragment.CreateTemplateFragmentRequest.Build()
    .WithTemplateId(TEMPLATE_ID)
    .WithText("The authentication code for your ${brand} is: ${code}")
    .WithLocale(Locale.EnUs)
    .WithChannel(VerificationChannel.Sms)
    .Create();
var response = await client.VerifyV2Client.CreateTemplateFragmentAsync(request);

全文を見る

前提条件

composer require vonage/client

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

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

全文を見る

コードを書く

create-template-fragment.php に以下を追加する：

$createFragmentRequest = new CreateCustomTemplateFragmentRequest(
    'sms',
    'en-us',
    'The authentication code for your ${brand} is: ${code}'
);

$client->verify2()->createCustomTemplateFragment(TEMPLATE_ID, $createFragmentRequest);

全文を見る

コードを実行する

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

php create-template-fragment.php

前提条件

gem install vonage

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

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

全文を見る

コードを書く

create-template-fragment.rb に以下を追加する：

client.verify2.template_fragments.create(
  template_id: VERIFY_TEMPLATE_ID,
  channel: 'sms',
  locale: 'en-us',
  text: 'The authentication code for your ${brand} is: ${code}'
)

全文を見る

コードを実行する

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

ruby create-template-fragment.rb