Create a Template Fragment
A Template Fragment is the template's content, identified uniquely by it's channel and locale. To create a Fragment, you will need to have already created a Template.
| Key | Description |
|---|---|
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 |
Write the code
Add the following to 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}"
}'
Run your code
Save this file to your machine and run it:
Prerequisites
npm install @vonage/server-sdkCreate a file named create-template-fragment.js and add the following code:
const { Vonage } = require('@vonage/server-sdk');
const vonage = new Vonage ({
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
});Write the code
Add the following to 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));Run your code
Save this file to your machine and run it:
Prerequisites
Add the following to build.gradle:
implementation 'com.vonage:server-sdk-kotlin:2.1.1'Create a class named CreateTemplateFragment and add the following code to the main method:
val client = Vonage {
applicationId(VONAGE_APPLICATION_ID)
privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}Write the code
Add the following to the main method of the CreateTemplateFragment class:
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)Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.verify.templates.fragments with the package containing CreateTemplateFragment:
Prerequisites
Add the following to build.gradle:
implementation 'com.vonage:server-sdk:9.3.1'Create a class named CreateTemplateFragment and add the following code to the main method:
VonageClient client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();Write the code
Add the following to the main method of the CreateTemplateFragment class:
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);Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''Run the following gradle command to execute your application, replacing com.vonage.quickstart.verify2.templates with the package containing CreateTemplateFragment:
Prerequisites
Install-Package VonageCreate a file named CreateTemplateFragmentRequest.cs and add the following code:
var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_APPLICATION_PRIVATE_KEY_PATH);
var client = new VonageClient(credentials);Write the code
Add the following to 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);Prerequisites
composer require vonage/clientCreate a file named create-template-fragment.php and add the following code:
Run your code
Save this file to your machine and run it:
Prerequisites
gem install vonageCreate a file named create-template-fragment.rb and add the following code:
Run your code
Save this file to your machine and run it: